AvaTax Brazil

AGAST

agastsCodeGet

This operation return agast configurations that match with parameters queries


/agasts/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/agasts/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AGASTApi;

import java.io.File;
import java.util.*;

public class AGASTApiExample {

    public static void main(String[] args) {
        
        AGASTApi apiInstance = new AGASTApi();
        String code = code_example; // String | Agast Code
        try {
            Agast result = apiInstance.agastsCodeGet(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#agastsCodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AGASTApi;

public class AGASTApiExample {

    public static void main(String[] args) {
        AGASTApi apiInstance = new AGASTApi();
        String code = code_example; // String | Agast Code
        try {
            Agast result = apiInstance.agastsCodeGet(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#agastsCodeGet");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Agast Code

AGASTApi *apiInstance = [[AGASTApi alloc] init];

[apiInstance agastsCodeGetWith:code
              completionHandler: ^(Agast output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AGASTApi()

var code = code_example; // {String} Agast Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.agastsCodeGet(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class agastsCodeGetExample
    {
        public void main()
        {
            
            var apiInstance = new AGASTApi();
            var code = code_example;  // String | Agast Code

            try
            {
                Agast result = apiInstance.agastsCodeGet(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AGASTApi.agastsCodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AGASTApi();
$code = code_example; // String | Agast Code

try {
    $result = $api_instance->agastsCodeGet($code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AGASTApi->agastsCodeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createAgast

Create agast

This method operation create a AGAST


/agasts

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/agasts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AGASTApi;

import java.io.File;
import java.util.*;

public class AGASTApiExample {

    public static void main(String[] args) {
        
        AGASTApi apiInstance = new AGASTApi();
        Agast body = ; // Agast | Transaction Message
        try {
            inline_response_201 result = apiInstance.createAgast(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#createAgast");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AGASTApi;

public class AGASTApiExample {

    public static void main(String[] args) {
        AGASTApi apiInstance = new AGASTApi();
        Agast body = ; // Agast | Transaction Message
        try {
            inline_response_201 result = apiInstance.createAgast(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#createAgast");
            e.printStackTrace();
        }
    }
}
Agast *body = ; // Transaction Message

AGASTApi *apiInstance = [[AGASTApi alloc] init];

// Create agast
[apiInstance createAgastWith:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AGASTApi()

var body = ; // {Agast} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAgast(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAgastExample
    {
        public void main()
        {
            
            var apiInstance = new AGASTApi();
            var body = new Agast(); // Agast | Transaction Message

            try
            {
                // Create agast
                inline_response_201 result = apiInstance.createAgast(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AGASTApi.createAgast: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AGASTApi();
$body = ; // Agast | Transaction Message

try {
    $result = $api_instance->createAgast($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AGASTApi->createAgast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteAgast


/agasts/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/agasts/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AGASTApi;

import java.io.File;
import java.util.*;

public class AGASTApiExample {

    public static void main(String[] args) {
        
        AGASTApi apiInstance = new AGASTApi();
        String code = code_example; // String | Agast Code
        try {
            apiInstance.deleteAgast(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#deleteAgast");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AGASTApi;

public class AGASTApiExample {

    public static void main(String[] args) {
        AGASTApi apiInstance = new AGASTApi();
        String code = code_example; // String | Agast Code
        try {
            apiInstance.deleteAgast(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#deleteAgast");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Agast Code

AGASTApi *apiInstance = [[AGASTApi alloc] init];

[apiInstance deleteAgastWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AGASTApi()

var code = code_example; // {String} Agast Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAgast(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAgastExample
    {
        public void main()
        {
            
            var apiInstance = new AGASTApi();
            var code = code_example;  // String | Agast Code

            try
            {
                apiInstance.deleteAgast(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AGASTApi.deleteAgast: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AGASTApi();
$code = code_example; // String | Agast Code

try {
    $api_instance->deleteAgast($code);
} catch (Exception $e) {
    echo 'Exception when calling AGASTApi->deleteAgast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getAgastList

This operation return agast configurations that match with parameters queries


/agasts

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/agasts?text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AGASTApi;

import java.io.File;
import java.util.*;

public class AGASTApiExample {

    public static void main(String[] args) {
        
        AGASTApi apiInstance = new AGASTApi();
        String text = text_example; // String | Text query
        try {
            array[inline_response_200_1] result = apiInstance.getAgastList(text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#getAgastList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AGASTApi;

public class AGASTApiExample {

    public static void main(String[] args) {
        AGASTApi apiInstance = new AGASTApi();
        String text = text_example; // String | Text query
        try {
            array[inline_response_200_1] result = apiInstance.getAgastList(text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#getAgastList");
            e.printStackTrace();
        }
    }
}
String *text = text_example; // Text query (optional)

AGASTApi *apiInstance = [[AGASTApi alloc] init];

[apiInstance getAgastListWith:text
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AGASTApi()

var opts = { 
  'text': text_example // {String} Text query
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAgastList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAgastListExample
    {
        public void main()
        {
            
            var apiInstance = new AGASTApi();
            var text = text_example;  // String | Text query (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.getAgastList(text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AGASTApi.getAgastList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AGASTApi();
$text = text_example; // String | Text query

try {
    $result = $api_instance->getAgastList($text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AGASTApi->getAgastList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
text

Responses

Status: 200 - Sucessful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateAgast

Update agast

This method operation create a agast


/agasts/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/agasts/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AGASTApi;

import java.io.File;
import java.util.*;

public class AGASTApiExample {

    public static void main(String[] args) {
        
        AGASTApi apiInstance = new AGASTApi();
        String code = code_example; // String | Agast Code
        Agast body = ; // Agast | Transaction Message
        try {
            apiInstance.updateAgast(code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#updateAgast");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AGASTApi;

public class AGASTApiExample {

    public static void main(String[] args) {
        AGASTApi apiInstance = new AGASTApi();
        String code = code_example; // String | Agast Code
        Agast body = ; // Agast | Transaction Message
        try {
            apiInstance.updateAgast(code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AGASTApi#updateAgast");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Agast Code
Agast *body = ; // Transaction Message

AGASTApi *apiInstance = [[AGASTApi alloc] init];

// Update agast
[apiInstance updateAgastWith:code
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AGASTApi()

var code = code_example; // {String} Agast Code

var body = ; // {Agast} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateAgast(codebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAgastExample
    {
        public void main()
        {
            
            var apiInstance = new AGASTApi();
            var code = code_example;  // String | Agast Code
            var body = new Agast(); // Agast | Transaction Message

            try
            {
                // Update agast
                apiInstance.updateAgast(code, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AGASTApi.updateAgast: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AGASTApi();
$code = code_example; // String | Agast Code
$body = ; // Agast | Transaction Message

try {
    $api_instance->updateAgast($code, $body);
} catch (Exception $e) {
    echo 'Exception when calling AGASTApi->updateAgast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


Account

accountsAccountIdCompaniesGet

Retrieve Companies by account

Retrieve list companies of one account


/accounts/{accountId}/companies

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/accounts/{accountId}/companies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        
        AccountApi apiInstance = new AccountApi();
        UUID accountId = accountId_example; // UUID | Account ID
        try {
            array[AccountCompany] result = apiInstance.accountsAccountIdCompaniesGet(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountsAccountIdCompaniesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        UUID accountId = accountId_example; // UUID | Account ID
        try {
            array[AccountCompany] result = apiInstance.accountsAccountIdCompaniesGet(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountsAccountIdCompaniesGet");
            e.printStackTrace();
        }
    }
}
UUID *accountId = accountId_example; // Account ID

AccountApi *apiInstance = [[AccountApi alloc] init];

// Retrieve Companies by account
[apiInstance accountsAccountIdCompaniesGetWith:accountId
              completionHandler: ^(array[AccountCompany] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AccountApi()

var accountId = accountId_example; // {UUID} Account ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountsAccountIdCompaniesGet(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountsAccountIdCompaniesGetExample
    {
        public void main()
        {
            
            var apiInstance = new AccountApi();
            var accountId = accountId_example;  // UUID | Account ID

            try
            {
                // Retrieve Companies by account
                array[AccountCompany] result = apiInstance.accountsAccountIdCompaniesGet(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountsAccountIdCompaniesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountId = accountId_example; // UUID | Account ID

try {
    $result = $api_instance->accountsAccountIdCompaniesGet($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountsAccountIdCompaniesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*

Responses

Status: 200 - List of Companies by Account

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createAccountCompany

Create company and your data configuration

This method operation create a company for a account


/accounts/{accountId}/companies

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/accounts/{accountId}/companies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        
        AccountApi apiInstance = new AccountApi();
        UUID accountId = accountId_example; // UUID | Account ID
        Body body = ; // Body | Company Code
        try {
            inline_response_201 result = apiInstance.createAccountCompany(accountId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#createAccountCompany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        UUID accountId = accountId_example; // UUID | Account ID
        Body body = ; // Body | Company Code
        try {
            inline_response_201 result = apiInstance.createAccountCompany(accountId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#createAccountCompany");
            e.printStackTrace();
        }
    }
}
UUID *accountId = accountId_example; // Account ID
Body *body = ; // Company Code

AccountApi *apiInstance = [[AccountApi alloc] init];

// Create company and your data configuration
[apiInstance createAccountCompanyWith:accountId
    body:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AccountApi()

var accountId = accountId_example; // {UUID} Account ID

var body = ; // {Body} Company Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccountCompany(accountId, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAccountCompanyExample
    {
        public void main()
        {
            
            var apiInstance = new AccountApi();
            var accountId = accountId_example;  // UUID | Account ID
            var body = new Body(); // Body | Company Code

            try
            {
                // Create company and your data configuration
                inline_response_201 result = apiInstance.createAccountCompany(accountId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.createAccountCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountId = accountId_example; // UUID | Account ID
$body = ; // Body | Company Code

try {
    $result = $api_instance->createAccountCompany($accountId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->createAccountCompany: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


Address

getZipCode

This operation return address


/addresses/{zipcode}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/addresses/{zipcode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressApi;

import java.io.File;
import java.util.*;

public class AddressApiExample {

    public static void main(String[] args) {
        
        AddressApi apiInstance = new AddressApi();
        String zipcode = zipcode_example; // String | ZIP Code
        try {
            array[Address] result = apiInstance.getZipCode(zipcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#getZipCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressApi;

public class AddressApiExample {

    public static void main(String[] args) {
        AddressApi apiInstance = new AddressApi();
        String zipcode = zipcode_example; // String | ZIP Code
        try {
            array[Address] result = apiInstance.getZipCode(zipcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#getZipCode");
            e.printStackTrace();
        }
    }
}
String *zipcode = zipcode_example; // ZIP Code

AddressApi *apiInstance = [[AddressApi alloc] init];

[apiInstance getZipCodeWith:zipcode
              completionHandler: ^(array[Address] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AddressApi()

var zipcode = zipcode_example; // {String} ZIP Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getZipCode(zipcode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getZipCodeExample
    {
        public void main()
        {
            
            var apiInstance = new AddressApi();
            var zipcode = zipcode_example;  // String | ZIP Code

            try
            {
                array[Address] result = apiInstance.getZipCode(zipcode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.getZipCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AddressApi();
$zipcode = zipcode_example; // String | ZIP Code

try {
    $result = $api_instance->getZipCode($zipcode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressApi->getZipCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
zipcode*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


Auth

authPost

authorization

Authorization: Basic VGVzdDoxMjM= Generate Base64: - auth = "{user}:{password}" - base = base64(auth) - header["Authorization"] = "Basic " + base


/auth

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/auth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String authorization = authorization_example; // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.

        try {
            inline_response_200 result = apiInstance.authPost(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#authPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String authorization = authorization_example; // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.

        try {
            inline_response_200 result = apiInstance.authPost(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#authPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.


AuthApi *apiInstance = [[AuthApi alloc] init];

// authorization
[apiInstance authPostWith:authorization
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AuthApi()

var authorization = authorization_example; // {String} Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.



var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authPost(authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authPostExample
    {
        public void main()
        {
            
            var apiInstance = new AuthApi();
            var authorization = authorization_example;  // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.


            try
            {
                // authorization
                inline_response_200 result = apiInstance.authPost(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.authPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AuthApi();
$authorization = authorization_example; // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.


try {
    $result = $api_instance->authPost($authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->authPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*

Responses

Status: 200 - Token


v2AuthPost

authorization

Authorization: Basic VGVzdDoxMjM= Generate Base64: - auth = "{user}:{password}" - base = base64(auth) - header["Authorization"] = "Basic " + base


/v2/auth

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/v2/auth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String authorization = authorization_example; // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.

        try {
            inline_response_200 result = apiInstance.v2AuthPost(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#v2AuthPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String authorization = authorization_example; // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.

        try {
            inline_response_200 result = apiInstance.v2AuthPost(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#v2AuthPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.


AuthApi *apiInstance = [[AuthApi alloc] init];

// authorization
[apiInstance v2AuthPostWith:authorization
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.AuthApi()

var authorization = authorization_example; // {String} Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.



var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v2AuthPost(authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class v2AuthPostExample
    {
        public void main()
        {
            
            var apiInstance = new AuthApi();
            var authorization = authorization_example;  // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.


            try
            {
                // authorization
                inline_response_200 result = apiInstance.v2AuthPost(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.v2AuthPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AuthApi();
$authorization = authorization_example; // String | Accepts "Basic + hash", where hash is {user}:{password} base64 encoded.


try {
    $result = $api_instance->v2AuthPost($authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->v2AuthPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*

Responses

Status: 200 - Token


Company

companiesGet

Retrieve Companies by account

Retrieve list companies of one account


/companies

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyApi;

import java.io.File;
import java.util.*;

public class CompanyApiExample {

    public static void main(String[] args) {
        
        CompanyApi apiInstance = new CompanyApi();
        try {
            array[Company] result = apiInstance.companiesGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#companiesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyApi;

public class CompanyApiExample {

    public static void main(String[] args) {
        CompanyApi apiInstance = new CompanyApi();
        try {
            array[Company] result = apiInstance.companiesGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#companiesGet");
            e.printStackTrace();
        }
    }
}

CompanyApi *apiInstance = [[CompanyApi alloc] init];

// Retrieve Companies by account
[apiInstance companiesGetWithCompletionHandler: 
              ^(array[Company] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyApi();

            try
            {
                // Retrieve Companies by account
                array[Company] result = apiInstance.companiesGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyApi.companiesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyApi();

try {
    $result = $api_instance->companiesGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyApi->companiesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createCompany

Create company and your data configuration

This method operation create a company for a account


/companies

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyApi;

import java.io.File;
import java.util.*;

public class CompanyApiExample {

    public static void main(String[] args) {
        
        CompanyApi apiInstance = new CompanyApi();
        Company body = ; // Company | Transaction Message
        try {
            Company result = apiInstance.createCompany(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#createCompany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyApi;

public class CompanyApiExample {

    public static void main(String[] args) {
        CompanyApi apiInstance = new CompanyApi();
        Company body = ; // Company | Transaction Message
        try {
            Company result = apiInstance.createCompany(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#createCompany");
            e.printStackTrace();
        }
    }
}
Company *body = ; // Transaction Message

CompanyApi *apiInstance = [[CompanyApi alloc] init];

// Create company and your data configuration
[apiInstance createCompanyWith:body
              completionHandler: ^(Company output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyApi()

var body = ; // {Company} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCompany(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCompanyExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyApi();
            var body = new Company(); // Company | Transaction Message

            try
            {
                // Create company and your data configuration
                Company result = apiInstance.createCompany(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyApi.createCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyApi();
$body = ; // Company | Transaction Message

try {
    $result = $api_instance->createCompany($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyApi->createCompany: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteAccountCompany


/accounts/{accountId}/companies/{companyId}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/accounts/{accountId}/companies/{companyId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyApi;

import java.io.File;
import java.util.*;

public class CompanyApiExample {

    public static void main(String[] args) {
        
        CompanyApi apiInstance = new CompanyApi();
        UUID accountId = accountId_example; // UUID | Account ID
        UUID companyId = companyId_example; // UUID | Company ID
        try {
            apiInstance.deleteAccountCompany(accountId, companyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#deleteAccountCompany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyApi;

public class CompanyApiExample {

    public static void main(String[] args) {
        CompanyApi apiInstance = new CompanyApi();
        UUID accountId = accountId_example; // UUID | Account ID
        UUID companyId = companyId_example; // UUID | Company ID
        try {
            apiInstance.deleteAccountCompany(accountId, companyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#deleteAccountCompany");
            e.printStackTrace();
        }
    }
}
UUID *accountId = accountId_example; // Account ID
UUID *companyId = companyId_example; // Company ID

CompanyApi *apiInstance = [[CompanyApi alloc] init];

[apiInstance deleteAccountCompanyWith:accountId
    companyId:companyId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyApi()

var accountId = accountId_example; // {UUID} Account ID

var companyId = companyId_example; // {UUID} Company ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAccountCompany(accountId, companyId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAccountCompanyExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyApi();
            var accountId = accountId_example;  // UUID | Account ID
            var companyId = companyId_example;  // UUID | Company ID

            try
            {
                apiInstance.deleteAccountCompany(accountId, companyId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyApi.deleteAccountCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyApi();
$accountId = accountId_example; // UUID | Account ID
$companyId = companyId_example; // UUID | Company ID

try {
    $api_instance->deleteAccountCompany($accountId, $companyId);
} catch (Exception $e) {
    echo 'Exception when calling CompanyApi->deleteAccountCompany: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
companyId*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteCompany


/companies/{companyId}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyApi;

import java.io.File;
import java.util.*;

public class CompanyApiExample {

    public static void main(String[] args) {
        
        CompanyApi apiInstance = new CompanyApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        try {
            apiInstance.deleteCompany(companyId, companyId2);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#deleteCompany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyApi;

public class CompanyApiExample {

    public static void main(String[] args) {
        CompanyApi apiInstance = new CompanyApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        try {
            apiInstance.deleteCompany(companyId, companyId2);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#deleteCompany");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
UUID *companyId2 = companyId_example; // Company ID

CompanyApi *apiInstance = [[CompanyApi alloc] init];

[apiInstance deleteCompanyWith:companyId
    companyId2:companyId2
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyApi()

var companyId = companyId_example; // {UUID} Company ID

var companyId2 = companyId_example; // {UUID} Company ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCompany(companyIdcompanyId2, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCompanyExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyApi();
            var companyId = companyId_example;  // UUID | Company ID
            var companyId2 = companyId_example;  // UUID | Company ID

            try
            {
                apiInstance.deleteCompany(companyId, companyId2);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyApi.deleteCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyApi();
$companyId = companyId_example; // UUID | Company ID
$companyId2 = companyId_example; // UUID | Company ID

try {
    $api_instance->deleteCompany($companyId, $companyId2);
} catch (Exception $e) {
    echo 'Exception when calling CompanyApi->deleteCompany: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
companyId2*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


infoCompany

Get company information and your data configuration

This method operation get a company for a account


/companies/{companyId}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyApi;

import java.io.File;
import java.util.*;

public class CompanyApiExample {

    public static void main(String[] args) {
        
        CompanyApi apiInstance = new CompanyApi();
        UUID companyId = companyId_example; // UUID | Company ID
        try {
            Company result = apiInstance.infoCompany(companyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#infoCompany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyApi;

public class CompanyApiExample {

    public static void main(String[] args) {
        CompanyApi apiInstance = new CompanyApi();
        UUID companyId = companyId_example; // UUID | Company ID
        try {
            Company result = apiInstance.infoCompany(companyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#infoCompany");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID

CompanyApi *apiInstance = [[CompanyApi alloc] init];

// Get company information and your data configuration
[apiInstance infoCompanyWith:companyId
              completionHandler: ^(Company output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyApi()

var companyId = companyId_example; // {UUID} Company ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.infoCompany(companyId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class infoCompanyExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyApi();
            var companyId = companyId_example;  // UUID | Company ID

            try
            {
                // Get company information and your data configuration
                Company result = apiInstance.infoCompany(companyId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyApi.infoCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyApi();
$companyId = companyId_example; // UUID | Company ID

try {
    $result = $api_instance->infoCompany($companyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyApi->infoCompany: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateCompany

Update company information and your data configuration

This method operation create a company for a account


/companies/{companyId}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyApi;

import java.io.File;
import java.util.*;

public class CompanyApiExample {

    public static void main(String[] args) {
        
        CompanyApi apiInstance = new CompanyApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Company body = ; // Company | Transaction Message
        try {
            apiInstance.updateCompany(companyId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#updateCompany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyApi;

public class CompanyApiExample {

    public static void main(String[] args) {
        CompanyApi apiInstance = new CompanyApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Company body = ; // Company | Transaction Message
        try {
            apiInstance.updateCompany(companyId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#updateCompany");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
Company *body = ; // Transaction Message

CompanyApi *apiInstance = [[CompanyApi alloc] init];

// Update company information and your data configuration
[apiInstance updateCompanyWith:companyId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {Company} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCompany(companyIdbody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCompanyExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new Company(); // Company | Transaction Message

            try
            {
                // Update company information and your data configuration
                apiInstance.updateCompany(companyId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyApi.updateCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // Company | Transaction Message

try {
    $api_instance->updateCompany($companyId, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyApi->updateCompany: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyAGAST

companiesCompanyIdAgastsCodeGet

This operation return custom agast configurations that match with parameters queries - Alannes.


/companies/{companyId}/agasts/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/agasts/{code}?parent="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyAGASTApi;

import java.io.File;
import java.util.*;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Agast Code
        String parent = parent_example; // String | Agast parent code, means that this agast is a specialization of parent agast

        try {
            CustomAgast result = apiInstance.companiesCompanyIdAgastsCodeGet(companyId, code, parent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#companiesCompanyIdAgastsCodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyAGASTApi;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Agast Code
        String parent = parent_example; // String | Agast parent code, means that this agast is a specialization of parent agast

        try {
            CustomAgast result = apiInstance.companiesCompanyIdAgastsCodeGet(companyId, code, parent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#companiesCompanyIdAgastsCodeGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Agast Code
String *parent = parent_example; // Agast parent code, means that this agast is a specialization of parent agast
 (optional)

CompanyAGASTApi *apiInstance = [[CompanyAGASTApi alloc] init];

[apiInstance companiesCompanyIdAgastsCodeGetWith:companyId
    code:code
    parent:parent
              completionHandler: ^(CustomAgast output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyAGASTApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Agast Code

var opts = { 
  'parent': parent_example // {String} Agast parent code, means that this agast is a specialization of parent agast

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdAgastsCodeGet(companyIdcode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdAgastsCodeGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyAGASTApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Agast Code
            var parent = parent_example;  // String | Agast parent code, means that this agast is a specialization of parent agast
 (optional) 

            try
            {
                CustomAgast result = apiInstance.companiesCompanyIdAgastsCodeGet(companyId, code, parent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyAGASTApi.companiesCompanyIdAgastsCodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyAGASTApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Agast Code
$parent = parent_example; // String | Agast parent code, means that this agast is a specialization of parent agast


try {
    $result = $api_instance->companiesCompanyIdAgastsCodeGet($companyId, $code, $parent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyAGASTApi->companiesCompanyIdAgastsCodeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Query parameters
Name Description
parent

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdAgastsGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/agasts

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/agasts?text=&agast=&parent="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyAGASTApi;

import java.io.File;
import java.util.*;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String text = text_example; // String | Text query
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        String agast = agast_example; // String | Custom Agast Code
        String parent = parent_example; // String | Agast Code
        try {
            array[inline_response_200_1] result = apiInstance.companiesCompanyIdAgastsGet(companyId, text, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, agast, parent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#companiesCompanyIdAgastsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyAGASTApi;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String text = text_example; // String | Text query
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        String agast = agast_example; // String | Custom Agast Code
        String parent = parent_example; // String | Agast Code
        try {
            array[inline_response_200_1] result = apiInstance.companiesCompanyIdAgastsGet(companyId, text, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, agast, parent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#companiesCompanyIdAgastsGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *text = text_example; // Text query (optional)
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)
String *agast = agast_example; // Custom Agast Code (optional)
String *parent = parent_example; // Agast Code (optional)

CompanyAGASTApi *apiInstance = [[CompanyAGASTApi alloc] init];

[apiInstance companiesCompanyIdAgastsGetWith:companyId
    text:text
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
    agast:agast
    parent:parent
              completionHandler: ^(array[inline_response_200_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyAGASTApi()

var companyId = companyId_example; // {UUID} Company ID

var opts = { 
  'text': text_example // {String} Text query
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
  'agast': agast_example // {String} Custom Agast Code
  'parent': parent_example // {String} Agast Code
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdAgastsGet(companyId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdAgastsGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyAGASTApi();
            var companyId = companyId_example;  // UUID | Company ID
            var text = text_example;  // String | Text query (optional) 
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 
            var agast = agast_example;  // String | Custom Agast Code (optional) 
            var parent = parent_example;  // String | Agast Code (optional) 

            try
            {
                array[inline_response_200_1] result = apiInstance.companiesCompanyIdAgastsGet(companyId, text, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, agast, parent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyAGASTApi.companiesCompanyIdAgastsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyAGASTApi();
$companyId = companyId_example; // UUID | Company ID
$text = text_example; // String | Text query
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 
$agast = agast_example; // String | Custom Agast Code
$parent = parent_example; // String | Agast Code

try {
    $result = $api_instance->companiesCompanyIdAgastsGet($companyId, $text, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort, $agast, $parent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyAGASTApi->companiesCompanyIdAgastsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
xPaginationLimit
xPaginationCurrentPage
xPaginationSort
Query parameters
Name Description
text
agast
parent

Responses

Status: 200 - Sucessful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createCustomAgast

Create custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/agasts

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/agasts?text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyAGASTApi;

import java.io.File;
import java.util.*;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomAgast body = ; // CustomAgast | Transaction Message
        String text = text_example; // String | Text query
        try {
            inline_response_201 result = apiInstance.createCustomAgast(companyId, body, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#createCustomAgast");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyAGASTApi;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomAgast body = ; // CustomAgast | Transaction Message
        String text = text_example; // String | Text query
        try {
            inline_response_201 result = apiInstance.createCustomAgast(companyId, body, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#createCustomAgast");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
CustomAgast *body = ; // Transaction Message
String *text = text_example; // Text query (optional)

CompanyAGASTApi *apiInstance = [[CompanyAGASTApi alloc] init];

// Create custom agast for one company
[apiInstance createCustomAgastWith:companyId
    body:body
    text:text
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyAGASTApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {CustomAgast} Transaction Message

var opts = { 
  'text': text_example // {String} Text query
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCustomAgast(companyIdbody, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCustomAgastExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyAGASTApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new CustomAgast(); // CustomAgast | Transaction Message
            var text = text_example;  // String | Text query (optional) 

            try
            {
                // Create custom agast for one company
                inline_response_201 result = apiInstance.createCustomAgast(companyId, body, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyAGASTApi.createCustomAgast: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyAGASTApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // CustomAgast | Transaction Message
$text = text_example; // String | Text query

try {
    $result = $api_instance->createCustomAgast($companyId, $body, $text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyAGASTApi->createCustomAgast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Body parameters
Name Description
body *
Query parameters
Name Description
text

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteAgast


/companies/{companyId}/agasts/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/agasts/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyAGASTApi;

import java.io.File;
import java.util.*;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Agast Code
        try {
            apiInstance.deleteAgast(companyId, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#deleteAgast");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyAGASTApi;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Agast Code
        try {
            apiInstance.deleteAgast(companyId, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#deleteAgast");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Agast Code

CompanyAGASTApi *apiInstance = [[CompanyAGASTApi alloc] init];

[apiInstance deleteAgastWith:companyId
    code:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyAGASTApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Agast Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAgast(companyIdcode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAgastExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyAGASTApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Agast Code

            try
            {
                apiInstance.deleteAgast(companyId, code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyAGASTApi.deleteAgast: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyAGASTApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Agast Code

try {
    $api_instance->deleteAgast($companyId, $code);
} catch (Exception $e) {
    echo 'Exception when calling CompanyAGASTApi->deleteAgast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateCustomAgast

Update custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/agasts/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/agasts/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyAGASTApi;

import java.io.File;
import java.util.*;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Agast Code
        CustomAgast body = ; // CustomAgast | Transaction Message
        try {
            apiInstance.updateCustomAgast(companyId, code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#updateCustomAgast");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyAGASTApi;

public class CompanyAGASTApiExample {

    public static void main(String[] args) {
        CompanyAGASTApi apiInstance = new CompanyAGASTApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Agast Code
        CustomAgast body = ; // CustomAgast | Transaction Message
        try {
            apiInstance.updateCustomAgast(companyId, code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyAGASTApi#updateCustomAgast");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Agast Code
CustomAgast *body = ; // Transaction Message

CompanyAGASTApi *apiInstance = [[CompanyAGASTApi alloc] init];

// Update custom agast for one company
[apiInstance updateCustomAgastWith:companyId
    code:code
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyAGASTApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Agast Code

var body = ; // {CustomAgast} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCustomAgast(companyIdcodebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCustomAgastExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyAGASTApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Agast Code
            var body = new CustomAgast(); // CustomAgast | Transaction Message

            try
            {
                // Update custom agast for one company
                apiInstance.updateCustomAgast(companyId, code, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyAGASTApi.updateCustomAgast: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyAGASTApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Agast Code
$body = ; // CustomAgast | Transaction Message

try {
    $api_instance->updateCustomAgast($companyId, $code, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyAGASTApi->updateCustomAgast: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyFiles

companiesCompanyIdNfseCertificateDelete

Deletes a company file store.


/companies/{companyId}/nfse-certificate

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/nfse-certificate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyFilesApi;

import java.io.File;
import java.util.*;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        try {
            apiInstance.companiesCompanyIdNfseCertificateDelete(companyId, companyId2);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificateDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyFilesApi;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        try {
            apiInstance.companiesCompanyIdNfseCertificateDelete(companyId, companyId2);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificateDelete");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
UUID *companyId2 = companyId_example; // Company ID

CompanyFilesApi *apiInstance = [[CompanyFilesApi alloc] init];

[apiInstance companiesCompanyIdNfseCertificateDeleteWith:companyId
    companyId2:companyId2
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyFilesApi()

var companyId = companyId_example; // {UUID} Company ID

var companyId2 = companyId_example; // {UUID} Company ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.companiesCompanyIdNfseCertificateDelete(companyIdcompanyId2, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdNfseCertificateDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyFilesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var companyId2 = companyId_example;  // UUID | Company ID

            try
            {
                apiInstance.companiesCompanyIdNfseCertificateDelete(companyId, companyId2);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyFilesApi.companiesCompanyIdNfseCertificateDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyFilesApi();
$companyId = companyId_example; // UUID | Company ID
$companyId2 = companyId_example; // UUID | Company ID

try {
    $api_instance->companiesCompanyIdNfseCertificateDelete($companyId, $companyId2);
} catch (Exception $e) {
    echo 'Exception when calling CompanyFilesApi->companiesCompanyIdNfseCertificateDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
companyId2*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdNfseCertificateGet

Gets an existing NFSe certificate file for this company.


/companies/{companyId}/nfse-certificate

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/nfse-certificate?peek="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyFilesApi;

import java.io.File;
import java.util.*;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        BigDecimal peek = 3.4; // BigDecimal | Use this parameter to check the existence of the file without downloading it.
        try {
            apiInstance.companiesCompanyIdNfseCertificateGet(companyId, companyId2, peek);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyFilesApi;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        BigDecimal peek = 3.4; // BigDecimal | Use this parameter to check the existence of the file without downloading it.
        try {
            apiInstance.companiesCompanyIdNfseCertificateGet(companyId, companyId2, peek);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificateGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
UUID *companyId2 = companyId_example; // Company ID
BigDecimal *peek = 3.4; // Use this parameter to check the existence of the file without downloading it. (optional)

CompanyFilesApi *apiInstance = [[CompanyFilesApi alloc] init];

[apiInstance companiesCompanyIdNfseCertificateGetWith:companyId
    companyId2:companyId2
    peek:peek
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyFilesApi()

var companyId = companyId_example; // {UUID} Company ID

var companyId2 = companyId_example; // {UUID} Company ID

var opts = { 
  'peek': 3.4 // {BigDecimal} Use this parameter to check the existence of the file without downloading it.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.companiesCompanyIdNfseCertificateGet(companyIdcompanyId2, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdNfseCertificateGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyFilesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var companyId2 = companyId_example;  // UUID | Company ID
            var peek = 3.4;  // BigDecimal | Use this parameter to check the existence of the file without downloading it. (optional) 

            try
            {
                apiInstance.companiesCompanyIdNfseCertificateGet(companyId, companyId2, peek);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyFilesApi.companiesCompanyIdNfseCertificateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyFilesApi();
$companyId = companyId_example; // UUID | Company ID
$companyId2 = companyId_example; // UUID | Company ID
$peek = 3.4; // BigDecimal | Use this parameter to check the existence of the file without downloading it.

try {
    $api_instance->companiesCompanyIdNfseCertificateGet($companyId, $companyId2, $peek);
} catch (Exception $e) {
    echo 'Exception when calling CompanyFilesApi->companiesCompanyIdNfseCertificateGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
companyId2*
Query parameters
Name Description
peek

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdNfseCertificatePost

If it still not exists, uploads a new NFSe Certificate file for this company. Send the file as a base64 string.


/companies/{companyId}/nfse-certificate

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/nfse-certificate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyFilesApi;

import java.io.File;
import java.util.*;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Body_3 body = ; // Body_3 | Content
        try {
            inline_response_200_2 result = apiInstance.companiesCompanyIdNfseCertificatePost(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificatePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyFilesApi;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Body_3 body = ; // Body_3 | Content
        try {
            inline_response_200_2 result = apiInstance.companiesCompanyIdNfseCertificatePost(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificatePost");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
Body_3 *body = ; // Content

CompanyFilesApi *apiInstance = [[CompanyFilesApi alloc] init];

[apiInstance companiesCompanyIdNfseCertificatePostWith:companyId
    body:body
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyFilesApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {Body_3} Content


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdNfseCertificatePost(companyIdbody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdNfseCertificatePostExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyFilesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new Body_3(); // Body_3 | Content

            try
            {
                inline_response_200_2 result = apiInstance.companiesCompanyIdNfseCertificatePost(companyId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyFilesApi.companiesCompanyIdNfseCertificatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyFilesApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // Body_3 | Content

try {
    $result = $api_instance->companiesCompanyIdNfseCertificatePost($companyId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyFilesApi->companiesCompanyIdNfseCertificatePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Body parameters
Name Description
body *

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdNfseCertificatePut

Updates an existing NFSe certificate file for this company. Send the file as a base64 string.


/companies/{companyId}/nfse-certificate

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/nfse-certificate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyFilesApi;

import java.io.File;
import java.util.*;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        Body_2 body = ; // Body_2 | Content
        try {
            inline_response_200_2 result = apiInstance.companiesCompanyIdNfseCertificatePut(companyId, companyId2, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificatePut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyFilesApi;

public class CompanyFilesApiExample {

    public static void main(String[] args) {
        CompanyFilesApi apiInstance = new CompanyFilesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        UUID companyId2 = companyId_example; // UUID | Company ID
        Body_2 body = ; // Body_2 | Content
        try {
            inline_response_200_2 result = apiInstance.companiesCompanyIdNfseCertificatePut(companyId, companyId2, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyFilesApi#companiesCompanyIdNfseCertificatePut");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
UUID *companyId2 = companyId_example; // Company ID
Body_2 *body = ; // Content

CompanyFilesApi *apiInstance = [[CompanyFilesApi alloc] init];

[apiInstance companiesCompanyIdNfseCertificatePutWith:companyId
    companyId2:companyId2
    body:body
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyFilesApi()

var companyId = companyId_example; // {UUID} Company ID

var companyId2 = companyId_example; // {UUID} Company ID

var body = ; // {Body_2} Content


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdNfseCertificatePut(companyIdcompanyId2body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdNfseCertificatePutExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyFilesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var companyId2 = companyId_example;  // UUID | Company ID
            var body = new Body_2(); // Body_2 | Content

            try
            {
                inline_response_200_2 result = apiInstance.companiesCompanyIdNfseCertificatePut(companyId, companyId2, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyFilesApi.companiesCompanyIdNfseCertificatePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyFilesApi();
$companyId = companyId_example; // UUID | Company ID
$companyId2 = companyId_example; // UUID | Company ID
$body = ; // Body_2 | Content

try {
    $result = $api_instance->companiesCompanyIdNfseCertificatePut($companyId, $companyId2, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyFilesApi->companiesCompanyIdNfseCertificatePut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
companyId2*
Body parameters
Name Description
body *

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyICMS

companiesCompanyIdIcmsGet

This operation return custom ICMS configurations that match with parameters queries


/companies/{companyId}/icms

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/icms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyICMSApi;

import java.io.File;
import java.util.*;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[CustomIcmsConfByState] result = apiInstance.companiesCompanyIdIcmsGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#companiesCompanyIdIcmsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyICMSApi;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[CustomIcmsConfByState] result = apiInstance.companiesCompanyIdIcmsGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#companiesCompanyIdIcmsGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)

CompanyICMSApi *apiInstance = [[CompanyICMSApi alloc] init];

[apiInstance companiesCompanyIdIcmsGetWith:companyId
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
              completionHandler: ^(array[CustomIcmsConfByState] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyICMSApi()

var companyId = companyId_example; // {UUID} Company ID

var opts = { 
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdIcmsGet(companyId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdIcmsGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyICMSApi();
            var companyId = companyId_example;  // UUID | Company ID
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 

            try
            {
                array[CustomIcmsConfByState] result = apiInstance.companiesCompanyIdIcmsGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyICMSApi.companiesCompanyIdIcmsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyICMSApi();
$companyId = companyId_example; // UUID | Company ID
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 

try {
    $result = $api_instance->companiesCompanyIdIcmsGet($companyId, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyICMSApi->companiesCompanyIdIcmsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
xPaginationLimit
xPaginationCurrentPage
xPaginationSort

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdIcmsStateGet

This operation return custom ICMS configurations that match with parameters queries


/companies/{companyId}/icms/{state}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/icms/{state}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyICMSApi;

import java.io.File;
import java.util.*;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String state = state_example; // String | Brazilian State
        try {
            CustomIcmsConfByState result = apiInstance.companiesCompanyIdIcmsStateGet(companyId, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#companiesCompanyIdIcmsStateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyICMSApi;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String state = state_example; // String | Brazilian State
        try {
            CustomIcmsConfByState result = apiInstance.companiesCompanyIdIcmsStateGet(companyId, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#companiesCompanyIdIcmsStateGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *state = state_example; // Brazilian State

CompanyICMSApi *apiInstance = [[CompanyICMSApi alloc] init];

[apiInstance companiesCompanyIdIcmsStateGetWith:companyId
    state:state
              completionHandler: ^(CustomIcmsConfByState output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyICMSApi()

var companyId = companyId_example; // {UUID} Company ID

var state = state_example; // {String} Brazilian State


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdIcmsStateGet(companyIdstate, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdIcmsStateGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyICMSApi();
            var companyId = companyId_example;  // UUID | Company ID
            var state = state_example;  // String | Brazilian State

            try
            {
                CustomIcmsConfByState result = apiInstance.companiesCompanyIdIcmsStateGet(companyId, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyICMSApi.companiesCompanyIdIcmsStateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyICMSApi();
$companyId = companyId_example; // UUID | Company ID
$state = state_example; // String | Brazilian State

try {
    $result = $api_instance->companiesCompanyIdIcmsStateGet($companyId, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyICMSApi->companiesCompanyIdIcmsStateGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
state*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createICMS

Create custom ICMS tax for one company

This method operation create a custom agast for one company


/companies/{companyId}/icms

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/icms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyICMSApi;

import java.io.File;
import java.util.*;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomIcmsConfByState body = ; // CustomIcmsConfByState | Transaction Message
        try {
            inline_response_201 result = apiInstance.createICMS(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#createICMS");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyICMSApi;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomIcmsConfByState body = ; // CustomIcmsConfByState | Transaction Message
        try {
            inline_response_201 result = apiInstance.createICMS(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#createICMS");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
CustomIcmsConfByState *body = ; // Transaction Message

CompanyICMSApi *apiInstance = [[CompanyICMSApi alloc] init];

// Create custom ICMS tax for one company
[apiInstance createICMSWith:companyId
    body:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyICMSApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {CustomIcmsConfByState} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createICMS(companyIdbody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createICMSExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyICMSApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new CustomIcmsConfByState(); // CustomIcmsConfByState | Transaction Message

            try
            {
                // Create custom ICMS tax for one company
                inline_response_201 result = apiInstance.createICMS(companyId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyICMSApi.createICMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyICMSApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // CustomIcmsConfByState | Transaction Message

try {
    $result = $api_instance->createICMS($companyId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyICMSApi->createICMS: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteCustomIcmsConfByState


/companies/{companyId}/icms/{state}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/icms/{state}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyICMSApi;

import java.io.File;
import java.util.*;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String state = state_example; // String | Brazilian State
        try {
            apiInstance.deleteCustomIcmsConfByState(companyId, state);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#deleteCustomIcmsConfByState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyICMSApi;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String state = state_example; // String | Brazilian State
        try {
            apiInstance.deleteCustomIcmsConfByState(companyId, state);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#deleteCustomIcmsConfByState");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *state = state_example; // Brazilian State

CompanyICMSApi *apiInstance = [[CompanyICMSApi alloc] init];

[apiInstance deleteCustomIcmsConfByStateWith:companyId
    state:state
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyICMSApi()

var companyId = companyId_example; // {UUID} Company ID

var state = state_example; // {String} Brazilian State


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCustomIcmsConfByState(companyIdstate, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCustomIcmsConfByStateExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyICMSApi();
            var companyId = companyId_example;  // UUID | Company ID
            var state = state_example;  // String | Brazilian State

            try
            {
                apiInstance.deleteCustomIcmsConfByState(companyId, state);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyICMSApi.deleteCustomIcmsConfByState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyICMSApi();
$companyId = companyId_example; // UUID | Company ID
$state = state_example; // String | Brazilian State

try {
    $api_instance->deleteCustomIcmsConfByState($companyId, $state);
} catch (Exception $e) {
    echo 'Exception when calling CompanyICMSApi->deleteCustomIcmsConfByState: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
state*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateCustomIcmsConfByState

Update custom agast for one company

This method operation update a custom ICMS tax for one company


/companies/{companyId}/icms/{state}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/icms/{state}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyICMSApi;

import java.io.File;
import java.util.*;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String state = state_example; // String | Brazilian State
        CustomIcmsConfByState body = ; // CustomIcmsConfByState | Transaction Message
        try {
            apiInstance.updateCustomIcmsConfByState(companyId, state, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#updateCustomIcmsConfByState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyICMSApi;

public class CompanyICMSApiExample {

    public static void main(String[] args) {
        CompanyICMSApi apiInstance = new CompanyICMSApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String state = state_example; // String | Brazilian State
        CustomIcmsConfByState body = ; // CustomIcmsConfByState | Transaction Message
        try {
            apiInstance.updateCustomIcmsConfByState(companyId, state, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyICMSApi#updateCustomIcmsConfByState");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *state = state_example; // Brazilian State
CustomIcmsConfByState *body = ; // Transaction Message

CompanyICMSApi *apiInstance = [[CompanyICMSApi alloc] init];

// Update custom agast for one company
[apiInstance updateCustomIcmsConfByStateWith:companyId
    state:state
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyICMSApi()

var companyId = companyId_example; // {UUID} Company ID

var state = state_example; // {String} Brazilian State

var body = ; // {CustomIcmsConfByState} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCustomIcmsConfByState(companyIdstate, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCustomIcmsConfByStateExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyICMSApi();
            var companyId = companyId_example;  // UUID | Company ID
            var state = state_example;  // String | Brazilian State
            var body = new CustomIcmsConfByState(); // CustomIcmsConfByState | Transaction Message

            try
            {
                // Update custom agast for one company
                apiInstance.updateCustomIcmsConfByState(companyId, state, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyICMSApi.updateCustomIcmsConfByState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyICMSApi();
$companyId = companyId_example; // UUID | Company ID
$state = state_example; // String | Brazilian State
$body = ; // CustomIcmsConfByState | Transaction Message

try {
    $api_instance->updateCustomIcmsConfByState($companyId, $state, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyICMSApi->updateCustomIcmsConfByState: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
state*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyItemCPOMService

companiesCompanyIdItemsCodeCpomCityCodeGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/items/{code}/cpom/{cityCode}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}/cpom/{cityCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemCPOMServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        try {
            ItemCpom result = apiInstance.companiesCompanyIdItemsCodeCpomCityCodeGet(companyId, code, cityCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#companiesCompanyIdItemsCodeCpomCityCodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemCPOMServiceApi;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        try {
            ItemCpom result = apiInstance.companiesCompanyIdItemsCodeCpomCityCodeGet(companyId, code, cityCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#companiesCompanyIdItemsCodeCpomCityCodeGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
BigDecimal *cityCode = 3.4; // City Code

CompanyItemCPOMServiceApi *apiInstance = [[CompanyItemCPOMServiceApi alloc] init];

[apiInstance companiesCompanyIdItemsCodeCpomCityCodeGetWith:companyId
    code:code
    cityCode:cityCode
              completionHandler: ^(ItemCpom output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemCPOMServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var cityCode = 3.4; // {BigDecimal} City Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdItemsCodeCpomCityCodeGet(companyIdcode, cityCode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsCodeCpomCityCodeGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemCPOMServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var cityCode = 3.4;  // BigDecimal | City Code

            try
            {
                ItemCpom result = apiInstance.companiesCompanyIdItemsCodeCpomCityCodeGet(companyId, code, cityCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemCPOMServiceApi.companiesCompanyIdItemsCodeCpomCityCodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemCPOMServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$cityCode = 3.4; // BigDecimal | City Code

try {
    $result = $api_instance->companiesCompanyIdItemsCodeCpomCityCodeGet($companyId, $code, $cityCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemCPOMServiceApi->companiesCompanyIdItemsCodeCpomCityCodeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
cityCode*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdItemsCodeCpomGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/items/{code}/cpom

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}/cpom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemCPOMServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[ItemCpom] result = apiInstance.companiesCompanyIdItemsCodeCpomGet(companyId, code, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#companiesCompanyIdItemsCodeCpomGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemCPOMServiceApi;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[ItemCpom] result = apiInstance.companiesCompanyIdItemsCodeCpomGet(companyId, code, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#companiesCompanyIdItemsCodeCpomGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)

CompanyItemCPOMServiceApi *apiInstance = [[CompanyItemCPOMServiceApi alloc] init];

[apiInstance companiesCompanyIdItemsCodeCpomGetWith:companyId
    code:code
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
              completionHandler: ^(array[ItemCpom] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemCPOMServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var opts = { 
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdItemsCodeCpomGet(companyIdcode, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsCodeCpomGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemCPOMServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 

            try
            {
                array[ItemCpom] result = apiInstance.companiesCompanyIdItemsCodeCpomGet(companyId, code, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemCPOMServiceApi.companiesCompanyIdItemsCodeCpomGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemCPOMServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 

try {
    $result = $api_instance->companiesCompanyIdItemsCodeCpomGet($companyId, $code, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemCPOMServiceApi->companiesCompanyIdItemsCodeCpomGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Header parameters
Name Description
xPaginationLimit
xPaginationCurrentPage
xPaginationSort

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createItemCPOM

Create custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/items/{code}/cpom

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}/cpom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemCPOMServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        ItemCpom body = ; // ItemCpom | Transaction Message
        try {
            inline_response_201 result = apiInstance.createItemCPOM(companyId, code, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#createItemCPOM");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemCPOMServiceApi;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        ItemCpom body = ; // ItemCpom | Transaction Message
        try {
            inline_response_201 result = apiInstance.createItemCPOM(companyId, code, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#createItemCPOM");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
ItemCpom *body = ; // Transaction Message

CompanyItemCPOMServiceApi *apiInstance = [[CompanyItemCPOMServiceApi alloc] init];

// Create custom agast for one company
[apiInstance createItemCPOMWith:companyId
    code:code
    body:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemCPOMServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var body = ; // {ItemCpom} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createItemCPOM(companyIdcode, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createItemCPOMExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemCPOMServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var body = new ItemCpom(); // ItemCpom | Transaction Message

            try
            {
                // Create custom agast for one company
                inline_response_201 result = apiInstance.createItemCPOM(companyId, code, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemCPOMServiceApi.createItemCPOM: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemCPOMServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$body = ; // ItemCpom | Transaction Message

try {
    $result = $api_instance->createItemCPOM($companyId, $code, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemCPOMServiceApi->createItemCPOM: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteItemCPOM


/companies/{companyId}/items/{code}/cpom/{cityCode}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}/cpom/{cityCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemCPOMServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        try {
            apiInstance.deleteItemCPOM(companyId, code, cityCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#deleteItemCPOM");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemCPOMServiceApi;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        try {
            apiInstance.deleteItemCPOM(companyId, code, cityCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#deleteItemCPOM");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
BigDecimal *cityCode = 3.4; // City Code

CompanyItemCPOMServiceApi *apiInstance = [[CompanyItemCPOMServiceApi alloc] init];

[apiInstance deleteItemCPOMWith:companyId
    code:code
    cityCode:cityCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemCPOMServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var cityCode = 3.4; // {BigDecimal} City Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteItemCPOM(companyIdcode, cityCode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteItemCPOMExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemCPOMServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var cityCode = 3.4;  // BigDecimal | City Code

            try
            {
                apiInstance.deleteItemCPOM(companyId, code, cityCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemCPOMServiceApi.deleteItemCPOM: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemCPOMServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$cityCode = 3.4; // BigDecimal | City Code

try {
    $api_instance->deleteItemCPOM($companyId, $code, $cityCode);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemCPOMServiceApi->deleteItemCPOM: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
cityCode*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateItemCPOM

Update custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/items/{code}/cpom/{cityCode}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}/cpom/{cityCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemCPOMServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        ItemCpom body = ; // ItemCpom | Transaction Message
        try {
            apiInstance.updateItemCPOM(companyId, code, cityCode, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#updateItemCPOM");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemCPOMServiceApi;

public class CompanyItemCPOMServiceApiExample {

    public static void main(String[] args) {
        CompanyItemCPOMServiceApi apiInstance = new CompanyItemCPOMServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        ItemCpom body = ; // ItemCpom | Transaction Message
        try {
            apiInstance.updateItemCPOM(companyId, code, cityCode, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemCPOMServiceApi#updateItemCPOM");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
BigDecimal *cityCode = 3.4; // City Code
ItemCpom *body = ; // Transaction Message

CompanyItemCPOMServiceApi *apiInstance = [[CompanyItemCPOMServiceApi alloc] init];

// Update custom agast for one company
[apiInstance updateItemCPOMWith:companyId
    code:code
    cityCode:cityCode
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemCPOMServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var cityCode = 3.4; // {BigDecimal} City Code

var body = ; // {ItemCpom} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateItemCPOM(companyIdcode, cityCodebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateItemCPOMExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemCPOMServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var cityCode = 3.4;  // BigDecimal | City Code
            var body = new ItemCpom(); // ItemCpom | Transaction Message

            try
            {
                // Update custom agast for one company
                apiInstance.updateItemCPOM(companyId, code, cityCode, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemCPOMServiceApi.updateItemCPOM: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemCPOMServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$cityCode = 3.4; // BigDecimal | City Code
$body = ; // ItemCpom | Transaction Message

try {
    $api_instance->updateItemCPOM($companyId, $code, $cityCode, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemCPOMServiceApi->updateItemCPOM: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
cityCode*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyItemGoods

companiesCompanyIdItemsCodeChangeCodePut

Change the code of a given item.


/companies/{companyId}/items/{code}/change-code

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}/change-code?goods=&service="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemGoodsApi;

import java.io.File;
import java.util.*;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        Body_1 body = ; // Body_1 | Requisition
        String goods = goods_example; // String | Provide to apply to goods items.
        String service = service_example; // String | Provide to apply to service items.
        try {
            apiInstance.companiesCompanyIdItemsCodeChangeCodePut(companyId, code, body, goods, service);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#companiesCompanyIdItemsCodeChangeCodePut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemGoodsApi;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        Body_1 body = ; // Body_1 | Requisition
        String goods = goods_example; // String | Provide to apply to goods items.
        String service = service_example; // String | Provide to apply to service items.
        try {
            apiInstance.companiesCompanyIdItemsCodeChangeCodePut(companyId, code, body, goods, service);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#companiesCompanyIdItemsCodeChangeCodePut");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
Body_1 *body = ; // Requisition
String *goods = goods_example; // Provide to apply to goods items. (optional)
String *service = service_example; // Provide to apply to service items. (optional)

CompanyItemGoodsApi *apiInstance = [[CompanyItemGoodsApi alloc] init];

[apiInstance companiesCompanyIdItemsCodeChangeCodePutWith:companyId
    code:code
    body:body
    goods:goods
    service:service
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemGoodsApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var body = ; // {Body_1} Requisition

var opts = { 
  'goods': goods_example, // {String} Provide to apply to goods items.
  'service': service_example // {String} Provide to apply to service items.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.companiesCompanyIdItemsCodeChangeCodePut(companyIdcode, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsCodeChangeCodePutExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemGoodsApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var body = new Body_1(); // Body_1 | Requisition
            var goods = goods_example;  // String | Provide to apply to goods items. (optional) 
            var service = service_example;  // String | Provide to apply to service items. (optional) 

            try
            {
                apiInstance.companiesCompanyIdItemsCodeChangeCodePut(companyId, code, body, goods, service);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemGoodsApi.companiesCompanyIdItemsCodeChangeCodePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemGoodsApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$body = ; // Body_1 | Requisition
$goods = goods_example; // String | Provide to apply to goods items.
$service = service_example; // String | Provide to apply to service items.

try {
    $api_instance->companiesCompanyIdItemsCodeChangeCodePut($companyId, $code, $body, $goods, $service);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemGoodsApi->companiesCompanyIdItemsCodeChangeCodePut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Body parameters
Name Description
body *
Query parameters
Name Description
goods
service

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdItemsCodegoodsGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/items/{code}?goods

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}?goods?agast="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemGoodsApi;

import java.io.File;
import java.util.*;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        String agast = agast_example; // String | Custom Agast Code
        try {
            ItemGoods result = apiInstance.companiesCompanyIdItemsCodegoodsGet(companyId, code, avalaraProductType, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#companiesCompanyIdItemsCodegoodsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemGoodsApi;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        String agast = agast_example; // String | Custom Agast Code
        try {
            ItemGoods result = apiInstance.companiesCompanyIdItemsCodegoodsGet(companyId, code, avalaraProductType, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#companiesCompanyIdItemsCodegoodsGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (default to goods)
String *agast = agast_example; // Custom Agast Code (optional)

CompanyItemGoodsApi *apiInstance = [[CompanyItemGoodsApi alloc] init];

[apiInstance companiesCompanyIdItemsCodegoodsGetWith:companyId
    code:code
    avalaraProductType:avalaraProductType
    agast:agast
              completionHandler: ^(ItemGoods output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemGoodsApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var avalaraProductType = avalaraProductType_example; // {String} Avalara Product Type

var opts = { 
  'agast': agast_example // {String} Custom Agast Code
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdItemsCodegoodsGet(companyIdcode, avalaraProductType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsCodegoodsGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemGoodsApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (default to goods)
            var agast = agast_example;  // String | Custom Agast Code (optional) 

            try
            {
                ItemGoods result = apiInstance.companiesCompanyIdItemsCodegoodsGet(companyId, code, avalaraProductType, agast);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemGoodsApi.companiesCompanyIdItemsCodegoodsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemGoodsApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
$agast = agast_example; // String | Custom Agast Code

try {
    $result = $api_instance->companiesCompanyIdItemsCodegoodsGet($companyId, $code, $avalaraProductType, $agast);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemGoodsApi->companiesCompanyIdItemsCodegoodsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Header parameters
Name Description
avalaraProductType*
Query parameters
Name Description
agast

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdItemsgoodsGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/items?goods

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items?goods?code=&agast="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemGoodsApi;

import java.io.File;
import java.util.*;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        String code = code_example; // String | Item Code
        String agast = agast_example; // String | Custom Agast Code
        try {
            array[ItemGoods] result = apiInstance.companiesCompanyIdItemsgoodsGet(companyId, avalaraProductType, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, code, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#companiesCompanyIdItemsgoodsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemGoodsApi;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        String code = code_example; // String | Item Code
        String agast = agast_example; // String | Custom Agast Code
        try {
            array[ItemGoods] result = apiInstance.companiesCompanyIdItemsgoodsGet(companyId, avalaraProductType, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, code, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#companiesCompanyIdItemsgoodsGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (default to goods)
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)
String *code = code_example; // Item Code (optional)
String *agast = agast_example; // Custom Agast Code (optional)

CompanyItemGoodsApi *apiInstance = [[CompanyItemGoodsApi alloc] init];

[apiInstance companiesCompanyIdItemsgoodsGetWith:companyId
    avalaraProductType:avalaraProductType
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
    code:code
    agast:agast
              completionHandler: ^(array[ItemGoods] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemGoodsApi()

var companyId = companyId_example; // {UUID} Company ID

var avalaraProductType = avalaraProductType_example; // {String} Avalara Product Type

var opts = { 
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
  'code': code_example, // {String} Item Code
  'agast': agast_example // {String} Custom Agast Code
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdItemsgoodsGet(companyIdavalaraProductType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsgoodsGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemGoodsApi();
            var companyId = companyId_example;  // UUID | Company ID
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (default to goods)
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 
            var code = code_example;  // String | Item Code (optional) 
            var agast = agast_example;  // String | Custom Agast Code (optional) 

            try
            {
                array[ItemGoods] result = apiInstance.companiesCompanyIdItemsgoodsGet(companyId, avalaraProductType, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, code, agast);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemGoodsApi.companiesCompanyIdItemsgoodsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemGoodsApi();
$companyId = companyId_example; // UUID | Company ID
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 
$code = code_example; // String | Item Code
$agast = agast_example; // String | Custom Agast Code

try {
    $result = $api_instance->companiesCompanyIdItemsgoodsGet($companyId, $avalaraProductType, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort, $code, $agast);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemGoodsApi->companiesCompanyIdItemsgoodsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
avalaraProductType*
xPaginationLimit
xPaginationCurrentPage
xPaginationSort
Query parameters
Name Description
code
agast

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createItem

Create custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/items?goods

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items?goods"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemGoodsApi;

import java.io.File;
import java.util.*;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        ItemGoods body = ; // ItemGoods | Transaction Message
        try {
            inline_response_201 result = apiInstance.createItem(companyId, avalaraProductType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#createItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemGoodsApi;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        ItemGoods body = ; // ItemGoods | Transaction Message
        try {
            inline_response_201 result = apiInstance.createItem(companyId, avalaraProductType, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#createItem");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (default to goods)
ItemGoods *body = ; // Transaction Message

CompanyItemGoodsApi *apiInstance = [[CompanyItemGoodsApi alloc] init];

// Create custom agast for one company
[apiInstance createItemWith:companyId
    avalaraProductType:avalaraProductType
    body:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemGoodsApi()

var companyId = companyId_example; // {UUID} Company ID

var avalaraProductType = avalaraProductType_example; // {String} Avalara Product Type

var body = ; // {ItemGoods} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createItem(companyIdavalaraProductTypebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createItemExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemGoodsApi();
            var companyId = companyId_example;  // UUID | Company ID
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (default to goods)
            var body = new ItemGoods(); // ItemGoods | Transaction Message

            try
            {
                // Create custom agast for one company
                inline_response_201 result = apiInstance.createItem(companyId, avalaraProductType, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemGoodsApi.createItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemGoodsApi();
$companyId = companyId_example; // UUID | Company ID
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
$body = ; // ItemGoods | Transaction Message

try {
    $result = $api_instance->createItem($companyId, $avalaraProductType, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemGoodsApi->createItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
avalaraProductType*
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteItem


/companies/{companyId}/items/{code}?goods

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}?goods"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemGoodsApi;

import java.io.File;
import java.util.*;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            apiInstance.deleteItem(companyId, code, avalaraProductType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#deleteItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemGoodsApi;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            apiInstance.deleteItem(companyId, code, avalaraProductType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#deleteItem");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (default to goods)

CompanyItemGoodsApi *apiInstance = [[CompanyItemGoodsApi alloc] init];

[apiInstance deleteItemWith:companyId
    code:code
    avalaraProductType:avalaraProductType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemGoodsApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var avalaraProductType = avalaraProductType_example; // {String} Avalara Product Type


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteItem(companyIdcode, avalaraProductType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteItemExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemGoodsApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (default to goods)

            try
            {
                apiInstance.deleteItem(companyId, code, avalaraProductType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemGoodsApi.deleteItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemGoodsApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type

try {
    $api_instance->deleteItem($companyId, $code, $avalaraProductType);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemGoodsApi->deleteItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Header parameters
Name Description
avalaraProductType*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateItem

Update custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/items/{code}?goods

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}?goods"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemGoodsApi;

import java.io.File;
import java.util.*;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        ItemGoods body = ; // ItemGoods | Transaction Message
        try {
            apiInstance.updateItem(companyId, code, avalaraProductType, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#updateItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemGoodsApi;

public class CompanyItemGoodsApiExample {

    public static void main(String[] args) {
        CompanyItemGoodsApi apiInstance = new CompanyItemGoodsApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        ItemGoods body = ; // ItemGoods | Transaction Message
        try {
            apiInstance.updateItem(companyId, code, avalaraProductType, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemGoodsApi#updateItem");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (default to goods)
ItemGoods *body = ; // Transaction Message

CompanyItemGoodsApi *apiInstance = [[CompanyItemGoodsApi alloc] init];

// Update custom agast for one company
[apiInstance updateItemWith:companyId
    code:code
    avalaraProductType:avalaraProductType
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemGoodsApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var avalaraProductType = avalaraProductType_example; // {String} Avalara Product Type

var body = ; // {ItemGoods} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateItem(companyIdcode, avalaraProductTypebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateItemExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemGoodsApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (default to goods)
            var body = new ItemGoods(); // ItemGoods | Transaction Message

            try
            {
                // Update custom agast for one company
                apiInstance.updateItem(companyId, code, avalaraProductType, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemGoodsApi.updateItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemGoodsApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
$body = ; // ItemGoods | Transaction Message

try {
    $api_instance->updateItem($companyId, $code, $avalaraProductType, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemGoodsApi->updateItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Header parameters
Name Description
avalaraProductType*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyItemService

companiesCompanyIdItemsCodeChangeCodePut

Change the code of a given item.


/companies/{companyId}/items/{code}/change-code

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}/change-code?goods=&service="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        Body_1 body = ; // Body_1 | Requisition
        String goods = goods_example; // String | Provide to apply to goods items.
        String service = service_example; // String | Provide to apply to service items.
        try {
            apiInstance.companiesCompanyIdItemsCodeChangeCodePut(companyId, code, body, goods, service);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#companiesCompanyIdItemsCodeChangeCodePut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemServiceApi;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        Body_1 body = ; // Body_1 | Requisition
        String goods = goods_example; // String | Provide to apply to goods items.
        String service = service_example; // String | Provide to apply to service items.
        try {
            apiInstance.companiesCompanyIdItemsCodeChangeCodePut(companyId, code, body, goods, service);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#companiesCompanyIdItemsCodeChangeCodePut");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
Body_1 *body = ; // Requisition
String *goods = goods_example; // Provide to apply to goods items. (optional)
String *service = service_example; // Provide to apply to service items. (optional)

CompanyItemServiceApi *apiInstance = [[CompanyItemServiceApi alloc] init];

[apiInstance companiesCompanyIdItemsCodeChangeCodePutWith:companyId
    code:code
    body:body
    goods:goods
    service:service
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var body = ; // {Body_1} Requisition

var opts = { 
  'goods': goods_example, // {String} Provide to apply to goods items.
  'service': service_example // {String} Provide to apply to service items.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.companiesCompanyIdItemsCodeChangeCodePut(companyIdcode, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsCodeChangeCodePutExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var body = new Body_1(); // Body_1 | Requisition
            var goods = goods_example;  // String | Provide to apply to goods items. (optional) 
            var service = service_example;  // String | Provide to apply to service items. (optional) 

            try
            {
                apiInstance.companiesCompanyIdItemsCodeChangeCodePut(companyId, code, body, goods, service);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemServiceApi.companiesCompanyIdItemsCodeChangeCodePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$body = ; // Body_1 | Requisition
$goods = goods_example; // String | Provide to apply to goods items.
$service = service_example; // String | Provide to apply to service items.

try {
    $api_instance->companiesCompanyIdItemsCodeChangeCodePut($companyId, $code, $body, $goods, $service);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemServiceApi->companiesCompanyIdItemsCodeChangeCodePut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Body parameters
Name Description
body *
Query parameters
Name Description
goods
service

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdItemsCodeserviceGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/items/{code}?service

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}?service?agast="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        String agast = agast_example; // String | Custom Agast Code
        try {
            ItemSimple result = apiInstance.companiesCompanyIdItemsCodeserviceGet(companyId, code, avalaraProductType, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#companiesCompanyIdItemsCodeserviceGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemServiceApi;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        String agast = agast_example; // String | Custom Agast Code
        try {
            ItemSimple result = apiInstance.companiesCompanyIdItemsCodeserviceGet(companyId, code, avalaraProductType, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#companiesCompanyIdItemsCodeserviceGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (optional) (default to service)
String *agast = agast_example; // Custom Agast Code (optional)

CompanyItemServiceApi *apiInstance = [[CompanyItemServiceApi alloc] init];

[apiInstance companiesCompanyIdItemsCodeserviceGetWith:companyId
    code:code
    avalaraProductType:avalaraProductType
    agast:agast
              completionHandler: ^(ItemSimple output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var opts = { 
  'avalaraProductType': avalaraProductType_example // {String} Avalara Product Type
  'agast': agast_example // {String} Custom Agast Code
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdItemsCodeserviceGet(companyIdcode, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsCodeserviceGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (optional)  (default to service)
            var agast = agast_example;  // String | Custom Agast Code (optional) 

            try
            {
                ItemSimple result = apiInstance.companiesCompanyIdItemsCodeserviceGet(companyId, code, avalaraProductType, agast);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemServiceApi.companiesCompanyIdItemsCodeserviceGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
$agast = agast_example; // String | Custom Agast Code

try {
    $result = $api_instance->companiesCompanyIdItemsCodeserviceGet($companyId, $code, $avalaraProductType, $agast);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemServiceApi->companiesCompanyIdItemsCodeserviceGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Header parameters
Name Description
avalaraProductType
Query parameters
Name Description
agast

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdItemsserviceGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/items?service

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items?service?code=&agast="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        String code = code_example; // String | Item Code
        String agast = agast_example; // String | Custom Agast Code
        try {
            array[ItemSimple] result = apiInstance.companiesCompanyIdItemsserviceGet(companyId, avalaraProductType, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, code, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#companiesCompanyIdItemsserviceGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemServiceApi;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        String code = code_example; // String | Item Code
        String agast = agast_example; // String | Custom Agast Code
        try {
            array[ItemSimple] result = apiInstance.companiesCompanyIdItemsserviceGet(companyId, avalaraProductType, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, code, agast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#companiesCompanyIdItemsserviceGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (optional) (default to service)
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)
String *code = code_example; // Item Code (optional)
String *agast = agast_example; // Custom Agast Code (optional)

CompanyItemServiceApi *apiInstance = [[CompanyItemServiceApi alloc] init];

[apiInstance companiesCompanyIdItemsserviceGetWith:companyId
    avalaraProductType:avalaraProductType
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
    code:code
    agast:agast
              completionHandler: ^(array[ItemSimple] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var opts = { 
  'avalaraProductType': avalaraProductType_example // {String} Avalara Product Type
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
  'code': code_example, // {String} Item Code
  'agast': agast_example // {String} Custom Agast Code
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdItemsserviceGet(companyId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdItemsserviceGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (optional)  (default to service)
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 
            var code = code_example;  // String | Item Code (optional) 
            var agast = agast_example;  // String | Custom Agast Code (optional) 

            try
            {
                array[ItemSimple] result = apiInstance.companiesCompanyIdItemsserviceGet(companyId, avalaraProductType, xPaginationLimit, xPaginationCurrentPage, xPaginationSort, code, agast);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemServiceApi.companiesCompanyIdItemsserviceGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemServiceApi();
$companyId = companyId_example; // UUID | Company ID
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 
$code = code_example; // String | Item Code
$agast = agast_example; // String | Custom Agast Code

try {
    $result = $api_instance->companiesCompanyIdItemsserviceGet($companyId, $avalaraProductType, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort, $code, $agast);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemServiceApi->companiesCompanyIdItemsserviceGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
avalaraProductType
xPaginationLimit
xPaginationCurrentPage
xPaginationSort
Query parameters
Name Description
code
agast

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createItemService

Create custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/items?service

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items?service"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        ItemSimple body = ; // ItemSimple | Transaction Message
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            inline_response_201 result = apiInstance.createItemService(companyId, body, avalaraProductType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#createItemService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemServiceApi;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        ItemSimple body = ; // ItemSimple | Transaction Message
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            inline_response_201 result = apiInstance.createItemService(companyId, body, avalaraProductType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#createItemService");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
ItemSimple *body = ; // Transaction Message
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (optional) (default to service)

CompanyItemServiceApi *apiInstance = [[CompanyItemServiceApi alloc] init];

// Create custom agast for one company
[apiInstance createItemServiceWith:companyId
    body:body
    avalaraProductType:avalaraProductType
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {ItemSimple} Transaction Message

var opts = { 
  'avalaraProductType': avalaraProductType_example // {String} Avalara Product Type
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createItemService(companyIdbody, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createItemServiceExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new ItemSimple(); // ItemSimple | Transaction Message
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (optional)  (default to service)

            try
            {
                // Create custom agast for one company
                inline_response_201 result = apiInstance.createItemService(companyId, body, avalaraProductType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemServiceApi.createItemService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemServiceApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // ItemSimple | Transaction Message
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type

try {
    $result = $api_instance->createItemService($companyId, $body, $avalaraProductType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemServiceApi->createItemService: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
avalaraProductType
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteItemService


/companies/{companyId}/items/{code}?service

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}?service"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            apiInstance.deleteItemService(companyId, code, avalaraProductType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#deleteItemService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemServiceApi;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            apiInstance.deleteItemService(companyId, code, avalaraProductType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#deleteItemService");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (optional) (default to service)

CompanyItemServiceApi *apiInstance = [[CompanyItemServiceApi alloc] init];

[apiInstance deleteItemServiceWith:companyId
    code:code
    avalaraProductType:avalaraProductType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var opts = { 
  'avalaraProductType': avalaraProductType_example // {String} Avalara Product Type
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteItemService(companyIdcode, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteItemServiceExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (optional)  (default to service)

            try
            {
                apiInstance.deleteItemService(companyId, code, avalaraProductType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemServiceApi.deleteItemService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type

try {
    $api_instance->deleteItemService($companyId, $code, $avalaraProductType);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemServiceApi->deleteItemService: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Header parameters
Name Description
avalaraProductType

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateItemService

Update custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/items/{code}?service

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/items/{code}?service"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyItemServiceApi;

import java.io.File;
import java.util.*;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        ItemSimple body = ; // ItemSimple | Transaction Message
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            apiInstance.updateItemService(companyId, code, body, avalaraProductType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#updateItemService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyItemServiceApi;

public class CompanyItemServiceApiExample {

    public static void main(String[] args) {
        CompanyItemServiceApi apiInstance = new CompanyItemServiceApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Item Code
        ItemSimple body = ; // ItemSimple | Transaction Message
        String avalaraProductType = avalaraProductType_example; // String | Avalara Product Type
        try {
            apiInstance.updateItemService(companyId, code, body, avalaraProductType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyItemServiceApi#updateItemService");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Item Code
ItemSimple *body = ; // Transaction Message
String *avalaraProductType = avalaraProductType_example; // Avalara Product Type (optional) (default to service)

CompanyItemServiceApi *apiInstance = [[CompanyItemServiceApi alloc] init];

// Update custom agast for one company
[apiInstance updateItemServiceWith:companyId
    code:code
    body:body
    avalaraProductType:avalaraProductType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyItemServiceApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Item Code

var body = ; // {ItemSimple} Transaction Message

var opts = { 
  'avalaraProductType': avalaraProductType_example // {String} Avalara Product Type
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateItemService(companyIdcode, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateItemServiceExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyItemServiceApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Item Code
            var body = new ItemSimple(); // ItemSimple | Transaction Message
            var avalaraProductType = avalaraProductType_example;  // String | Avalara Product Type (optional)  (default to service)

            try
            {
                // Update custom agast for one company
                apiInstance.updateItemService(companyId, code, body, avalaraProductType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyItemServiceApi.updateItemService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyItemServiceApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Item Code
$body = ; // ItemSimple | Transaction Message
$avalaraProductType = avalaraProductType_example; // String | Avalara Product Type

try {
    $api_instance->updateItemService($companyId, $code, $body, $avalaraProductType);
} catch (Exception $e) {
    echo 'Exception when calling CompanyItemServiceApi->updateItemService: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Header parameters
Name Description
avalaraProductType
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyLocation

companiesCompanyIdLocationsCodeGet

This operation return location


/companies/{companyId}/locations/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/locations/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyLocationApi;

import java.io.File;
import java.util.*;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Location Code
        try {
            Location result = apiInstance.companiesCompanyIdLocationsCodeGet(companyId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#companiesCompanyIdLocationsCodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyLocationApi;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Location Code
        try {
            Location result = apiInstance.companiesCompanyIdLocationsCodeGet(companyId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#companiesCompanyIdLocationsCodeGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Location Code

CompanyLocationApi *apiInstance = [[CompanyLocationApi alloc] init];

[apiInstance companiesCompanyIdLocationsCodeGetWith:companyId
    code:code
              completionHandler: ^(Location output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyLocationApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Location Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdLocationsCodeGet(companyIdcode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdLocationsCodeGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyLocationApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Location Code

            try
            {
                Location result = apiInstance.companiesCompanyIdLocationsCodeGet(companyId, code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyLocationApi.companiesCompanyIdLocationsCodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyLocationApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Location Code

try {
    $result = $api_instance->companiesCompanyIdLocationsCodeGet($companyId, $code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyLocationApi->companiesCompanyIdLocationsCodeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdLocationsGet

This operation return all locations


/companies/{companyId}/locations

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/locations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyLocationApi;

import java.io.File;
import java.util.*;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[Location] result = apiInstance.companiesCompanyIdLocationsGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#companiesCompanyIdLocationsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyLocationApi;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[Location] result = apiInstance.companiesCompanyIdLocationsGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#companiesCompanyIdLocationsGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)

CompanyLocationApi *apiInstance = [[CompanyLocationApi alloc] init];

[apiInstance companiesCompanyIdLocationsGetWith:companyId
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
              completionHandler: ^(array[Location] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyLocationApi()

var companyId = companyId_example; // {UUID} Company ID

var opts = { 
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdLocationsGet(companyId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdLocationsGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyLocationApi();
            var companyId = companyId_example;  // UUID | Company ID
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 

            try
            {
                array[Location] result = apiInstance.companiesCompanyIdLocationsGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyLocationApi.companiesCompanyIdLocationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyLocationApi();
$companyId = companyId_example; // UUID | Company ID
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 

try {
    $result = $api_instance->companiesCompanyIdLocationsGet($companyId, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyLocationApi->companiesCompanyIdLocationsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
xPaginationLimit
xPaginationCurrentPage
xPaginationSort

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createLocation

Create new location for company

This method operation create a new location for company


/companies/{companyId}/locations

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/locations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyLocationApi;

import java.io.File;
import java.util.*;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Location body = ; // Location | Transaction Message
        try {
            inline_response_201 result = apiInstance.createLocation(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#createLocation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyLocationApi;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Location body = ; // Location | Transaction Message
        try {
            inline_response_201 result = apiInstance.createLocation(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#createLocation");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
Location *body = ; // Transaction Message

CompanyLocationApi *apiInstance = [[CompanyLocationApi alloc] init];

// Create new location for company
[apiInstance createLocationWith:companyId
    body:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyLocationApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {Location} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createLocation(companyIdbody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createLocationExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyLocationApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new Location(); // Location | Transaction Message

            try
            {
                // Create new location for company
                inline_response_201 result = apiInstance.createLocation(companyId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyLocationApi.createLocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyLocationApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // Location | Transaction Message

try {
    $result = $api_instance->createLocation($companyId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyLocationApi->createLocation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteLocation


/companies/{companyId}/locations/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/locations/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyLocationApi;

import java.io.File;
import java.util.*;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Location Code
        try {
            apiInstance.deleteLocation(companyId, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#deleteLocation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyLocationApi;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Location Code
        try {
            apiInstance.deleteLocation(companyId, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#deleteLocation");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Location Code

CompanyLocationApi *apiInstance = [[CompanyLocationApi alloc] init];

[apiInstance deleteLocationWith:companyId
    code:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyLocationApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Location Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteLocation(companyIdcode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteLocationExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyLocationApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Location Code

            try
            {
                apiInstance.deleteLocation(companyId, code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyLocationApi.deleteLocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyLocationApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Location Code

try {
    $api_instance->deleteLocation($companyId, $code);
} catch (Exception $e) {
    echo 'Exception when calling CompanyLocationApi->deleteLocation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateLocation

Update location for company

This method operation update a location for company


/companies/{companyId}/locations/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/locations/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyLocationApi;

import java.io.File;
import java.util.*;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Location Code
        Location body = ; // Location | Transaction Message
        try {
            apiInstance.updateLocation(companyId, code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#updateLocation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyLocationApi;

public class CompanyLocationApiExample {

    public static void main(String[] args) {
        CompanyLocationApi apiInstance = new CompanyLocationApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Location Code
        Location body = ; // Location | Transaction Message
        try {
            apiInstance.updateLocation(companyId, code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyLocationApi#updateLocation");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Location Code
Location *body = ; // Transaction Message

CompanyLocationApi *apiInstance = [[CompanyLocationApi alloc] init];

// Update location for company
[apiInstance updateLocationWith:companyId
    code:code
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyLocationApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Location Code

var body = ; // {Location} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateLocation(companyIdcodebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateLocationExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyLocationApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Location Code
            var body = new Location(); // Location | Transaction Message

            try
            {
                // Update location for company
                apiInstance.updateLocation(companyId, code, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyLocationApi.updateLocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyLocationApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Location Code
$body = ; // Location | Transaction Message

try {
    $api_instance->updateLocation($companyId, $code, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyLocationApi->updateLocation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyProcess

companiesCompanyIdProcessCodeGet

This operation return custom process configurations that match with parameters queries


/companies/{companyId}/process/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/process/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyProcessApi;

import java.io.File;
import java.util.*;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Process Code
        try {
            CustomProcessScenario result = apiInstance.companiesCompanyIdProcessCodeGet(companyId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#companiesCompanyIdProcessCodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyProcessApi;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Process Code
        try {
            CustomProcessScenario result = apiInstance.companiesCompanyIdProcessCodeGet(companyId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#companiesCompanyIdProcessCodeGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Process Code

CompanyProcessApi *apiInstance = [[CompanyProcessApi alloc] init];

[apiInstance companiesCompanyIdProcessCodeGetWith:companyId
    code:code
              completionHandler: ^(CustomProcessScenario output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyProcessApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Process Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdProcessCodeGet(companyIdcode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdProcessCodeGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyProcessApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Process Code

            try
            {
                CustomProcessScenario result = apiInstance.companiesCompanyIdProcessCodeGet(companyId, code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyProcessApi.companiesCompanyIdProcessCodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyProcessApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Process Code

try {
    $result = $api_instance->companiesCompanyIdProcessCodeGet($companyId, $code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyProcessApi->companiesCompanyIdProcessCodeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdProcessGet

This operation return custom process configurations that match with parameters queries


/companies/{companyId}/process

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/process"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyProcessApi;

import java.io.File;
import java.util.*;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[CustomProcessScenario] result = apiInstance.companiesCompanyIdProcessGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#companiesCompanyIdProcessGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyProcessApi;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[CustomProcessScenario] result = apiInstance.companiesCompanyIdProcessGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#companiesCompanyIdProcessGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)

CompanyProcessApi *apiInstance = [[CompanyProcessApi alloc] init];

[apiInstance companiesCompanyIdProcessGetWith:companyId
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
              completionHandler: ^(array[CustomProcessScenario] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyProcessApi()

var companyId = companyId_example; // {UUID} Company ID

var opts = { 
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdProcessGet(companyId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdProcessGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyProcessApi();
            var companyId = companyId_example;  // UUID | Company ID
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 

            try
            {
                array[CustomProcessScenario] result = apiInstance.companiesCompanyIdProcessGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyProcessApi.companiesCompanyIdProcessGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyProcessApi();
$companyId = companyId_example; // UUID | Company ID
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 

try {
    $result = $api_instance->companiesCompanyIdProcessGet($companyId, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyProcessApi->companiesCompanyIdProcessGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
xPaginationLimit
xPaginationCurrentPage
xPaginationSort

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createCustomProcessScenario

Create custom process tax for one company

This method operation create a custom agast for one company


/companies/{companyId}/process

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/process"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyProcessApi;

import java.io.File;
import java.util.*;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomProcessScenario body = ; // CustomProcessScenario | Transaction Message
        try {
            inline_response_201 result = apiInstance.createCustomProcessScenario(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#createCustomProcessScenario");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyProcessApi;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomProcessScenario body = ; // CustomProcessScenario | Transaction Message
        try {
            inline_response_201 result = apiInstance.createCustomProcessScenario(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#createCustomProcessScenario");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
CustomProcessScenario *body = ; // Transaction Message

CompanyProcessApi *apiInstance = [[CompanyProcessApi alloc] init];

// Create custom process tax for one company
[apiInstance createCustomProcessScenarioWith:companyId
    body:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyProcessApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {CustomProcessScenario} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCustomProcessScenario(companyIdbody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCustomProcessScenarioExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyProcessApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new CustomProcessScenario(); // CustomProcessScenario | Transaction Message

            try
            {
                // Create custom process tax for one company
                inline_response_201 result = apiInstance.createCustomProcessScenario(companyId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyProcessApi.createCustomProcessScenario: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyProcessApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // CustomProcessScenario | Transaction Message

try {
    $result = $api_instance->createCustomProcessScenario($companyId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyProcessApi->createCustomProcessScenario: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteCustomProcessScenario


/companies/{companyId}/process/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/process/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyProcessApi;

import java.io.File;
import java.util.*;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Process Code
        try {
            apiInstance.deleteCustomProcessScenario(companyId, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#deleteCustomProcessScenario");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyProcessApi;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Process Code
        try {
            apiInstance.deleteCustomProcessScenario(companyId, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#deleteCustomProcessScenario");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Process Code

CompanyProcessApi *apiInstance = [[CompanyProcessApi alloc] init];

[apiInstance deleteCustomProcessScenarioWith:companyId
    code:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyProcessApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Process Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCustomProcessScenario(companyIdcode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCustomProcessScenarioExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyProcessApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Process Code

            try
            {
                apiInstance.deleteCustomProcessScenario(companyId, code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyProcessApi.deleteCustomProcessScenario: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyProcessApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Process Code

try {
    $api_instance->deleteCustomProcessScenario($companyId, $code);
} catch (Exception $e) {
    echo 'Exception when calling CompanyProcessApi->deleteCustomProcessScenario: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateCustomProcessScenario

Update custom agast for one company

This method operation update a custom process for one company


/companies/{companyId}/process/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/process/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyProcessApi;

import java.io.File;
import java.util.*;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Process Code
        CustomProcessScenario body = ; // CustomProcessScenario | Transaction Message
        try {
            apiInstance.updateCustomProcessScenario(companyId, code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#updateCustomProcessScenario");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyProcessApi;

public class CompanyProcessApiExample {

    public static void main(String[] args) {
        CompanyProcessApi apiInstance = new CompanyProcessApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String code = code_example; // String | Process Code
        CustomProcessScenario body = ; // CustomProcessScenario | Transaction Message
        try {
            apiInstance.updateCustomProcessScenario(companyId, code, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyProcessApi#updateCustomProcessScenario");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *code = code_example; // Process Code
CustomProcessScenario *body = ; // Transaction Message

CompanyProcessApi *apiInstance = [[CompanyProcessApi alloc] init];

// Update custom agast for one company
[apiInstance updateCustomProcessScenarioWith:companyId
    code:code
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyProcessApi()

var companyId = companyId_example; // {UUID} Company ID

var code = code_example; // {String} Process Code

var body = ; // {CustomProcessScenario} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCustomProcessScenario(companyIdcodebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCustomProcessScenarioExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyProcessApi();
            var companyId = companyId_example;  // UUID | Company ID
            var code = code_example;  // String | Process Code
            var body = new CustomProcessScenario(); // CustomProcessScenario | Transaction Message

            try
            {
                // Update custom agast for one company
                apiInstance.updateCustomProcessScenario(companyId, code, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyProcessApi.updateCustomProcessScenario: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyProcessApi();
$companyId = companyId_example; // UUID | Company ID
$code = code_example; // String | Process Code
$body = ; // CustomProcessScenario | Transaction Message

try {
    $api_instance->updateCustomProcessScenario($companyId, $code, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyProcessApi->updateCustomProcessScenario: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
code*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


CompanyTaxRates

companiesCompanyIdTaxratesGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/taxrates

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/taxrates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyTaxRatesApi;

import java.io.File;
import java.util.*;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[CustomTaxTypeRate] result = apiInstance.companiesCompanyIdTaxratesGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#companiesCompanyIdTaxratesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyTaxRatesApi;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        Integer xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
        Integer xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
        String xPaginationSort = xPaginationSort_example; // String | 
        try {
            array[CustomTaxTypeRate] result = apiInstance.companiesCompanyIdTaxratesGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#companiesCompanyIdTaxratesGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
Integer *xPaginationLimit = 56; // The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional) (default to 10)
Integer *xPaginationCurrentPage = 56; // The current page. Defaults to 1. (optional) (default to 1)
String *xPaginationSort = xPaginationSort_example; //  (optional)

CompanyTaxRatesApi *apiInstance = [[CompanyTaxRatesApi alloc] init];

[apiInstance companiesCompanyIdTaxratesGetWith:companyId
    xPaginationLimit:xPaginationLimit
    xPaginationCurrentPage:xPaginationCurrentPage
    xPaginationSort:xPaginationSort
              completionHandler: ^(array[CustomTaxTypeRate] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyTaxRatesApi()

var companyId = companyId_example; // {UUID} Company ID

var opts = { 
  'xPaginationLimit': 56, // {Integer} The per page limit. Currently set to 10 but subject to change at any time (max 100).
  'xPaginationCurrentPage': 56, // {Integer} The current page. Defaults to 1.
  'xPaginationSort': xPaginationSort_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdTaxratesGet(companyId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdTaxratesGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyTaxRatesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var xPaginationLimit = 56;  // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100). (optional)  (default to 10)
            var xPaginationCurrentPage = 56;  // Integer | The current page. Defaults to 1. (optional)  (default to 1)
            var xPaginationSort = xPaginationSort_example;  // String |  (optional) 

            try
            {
                array[CustomTaxTypeRate] result = apiInstance.companiesCompanyIdTaxratesGet(companyId, xPaginationLimit, xPaginationCurrentPage, xPaginationSort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyTaxRatesApi.companiesCompanyIdTaxratesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyTaxRatesApi();
$companyId = companyId_example; // UUID | Company ID
$xPaginationLimit = 56; // Integer | The per page limit. Currently set to 10 but subject to change at any time (max 100).
$xPaginationCurrentPage = 56; // Integer | The current page. Defaults to 1.
$xPaginationSort = xPaginationSort_example; // String | 

try {
    $result = $api_instance->companiesCompanyIdTaxratesGet($companyId, $xPaginationLimit, $xPaginationCurrentPage, $xPaginationSort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyTaxRatesApi->companiesCompanyIdTaxratesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Header parameters
Name Description
xPaginationLimit
xPaginationCurrentPage
xPaginationSort

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


companiesCompanyIdTaxratesTaxTypeGet

This operation return custom agast configurations that match with parameters queries


/companies/{companyId}/taxrates/{taxType}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/taxrates/{taxType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyTaxRatesApi;

import java.io.File;
import java.util.*;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String taxType = taxType_example; // String | Tax Type
        try {
            CustomTaxTypeRate result = apiInstance.companiesCompanyIdTaxratesTaxTypeGet(companyId, taxType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#companiesCompanyIdTaxratesTaxTypeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyTaxRatesApi;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String taxType = taxType_example; // String | Tax Type
        try {
            CustomTaxTypeRate result = apiInstance.companiesCompanyIdTaxratesTaxTypeGet(companyId, taxType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#companiesCompanyIdTaxratesTaxTypeGet");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *taxType = taxType_example; // Tax Type

CompanyTaxRatesApi *apiInstance = [[CompanyTaxRatesApi alloc] init];

[apiInstance companiesCompanyIdTaxratesTaxTypeGetWith:companyId
    taxType:taxType
              completionHandler: ^(CustomTaxTypeRate output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyTaxRatesApi()

var companyId = companyId_example; // {UUID} Company ID

var taxType = taxType_example; // {String} Tax Type


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.companiesCompanyIdTaxratesTaxTypeGet(companyIdtaxType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class companiesCompanyIdTaxratesTaxTypeGetExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyTaxRatesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var taxType = taxType_example;  // String | Tax Type

            try
            {
                CustomTaxTypeRate result = apiInstance.companiesCompanyIdTaxratesTaxTypeGet(companyId, taxType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyTaxRatesApi.companiesCompanyIdTaxratesTaxTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyTaxRatesApi();
$companyId = companyId_example; // UUID | Company ID
$taxType = taxType_example; // String | Tax Type

try {
    $result = $api_instance->companiesCompanyIdTaxratesTaxTypeGet($companyId, $taxType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyTaxRatesApi->companiesCompanyIdTaxratesTaxTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
taxType*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


createCustomTaxes

Create custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/taxrates

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/taxrates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyTaxRatesApi;

import java.io.File;
import java.util.*;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomTaxTypeRate body = ; // CustomTaxTypeRate | Transaction Message
        try {
            inline_response_201 result = apiInstance.createCustomTaxes(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#createCustomTaxes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyTaxRatesApi;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        CustomTaxTypeRate body = ; // CustomTaxTypeRate | Transaction Message
        try {
            inline_response_201 result = apiInstance.createCustomTaxes(companyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#createCustomTaxes");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
CustomTaxTypeRate *body = ; // Transaction Message

CompanyTaxRatesApi *apiInstance = [[CompanyTaxRatesApi alloc] init];

// Create custom agast for one company
[apiInstance createCustomTaxesWith:companyId
    body:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyTaxRatesApi()

var companyId = companyId_example; // {UUID} Company ID

var body = ; // {CustomTaxTypeRate} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCustomTaxes(companyIdbody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCustomTaxesExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyTaxRatesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var body = new CustomTaxTypeRate(); // CustomTaxTypeRate | Transaction Message

            try
            {
                // Create custom agast for one company
                inline_response_201 result = apiInstance.createCustomTaxes(companyId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyTaxRatesApi.createCustomTaxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyTaxRatesApi();
$companyId = companyId_example; // UUID | Company ID
$body = ; // CustomTaxTypeRate | Transaction Message

try {
    $result = $api_instance->createCustomTaxes($companyId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyTaxRatesApi->createCustomTaxes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteCustomTaxes


/companies/{companyId}/taxrates/{taxType}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/taxrates/{taxType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyTaxRatesApi;

import java.io.File;
import java.util.*;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String taxType = taxType_example; // String | Tax Type
        try {
            apiInstance.deleteCustomTaxes(companyId, taxType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#deleteCustomTaxes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyTaxRatesApi;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String taxType = taxType_example; // String | Tax Type
        try {
            apiInstance.deleteCustomTaxes(companyId, taxType);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#deleteCustomTaxes");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *taxType = taxType_example; // Tax Type

CompanyTaxRatesApi *apiInstance = [[CompanyTaxRatesApi alloc] init];

[apiInstance deleteCustomTaxesWith:companyId
    taxType:taxType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyTaxRatesApi()

var companyId = companyId_example; // {UUID} Company ID

var taxType = taxType_example; // {String} Tax Type


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCustomTaxes(companyIdtaxType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCustomTaxesExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyTaxRatesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var taxType = taxType_example;  // String | Tax Type

            try
            {
                apiInstance.deleteCustomTaxes(companyId, taxType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyTaxRatesApi.deleteCustomTaxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyTaxRatesApi();
$companyId = companyId_example; // UUID | Company ID
$taxType = taxType_example; // String | Tax Type

try {
    $api_instance->deleteCustomTaxes($companyId, $taxType);
} catch (Exception $e) {
    echo 'Exception when calling CompanyTaxRatesApi->deleteCustomTaxes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
taxType*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateCustomTaxes

Update custom agast for one company

This method operation create a custom agast for one company


/companies/{companyId}/taxrates/{taxType}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/companies/{companyId}/taxrates/{taxType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyTaxRatesApi;

import java.io.File;
import java.util.*;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String taxType = taxType_example; // String | Tax Type
        CustomTaxTypeRate body = ; // CustomTaxTypeRate | Transaction Message
        try {
            apiInstance.updateCustomTaxes(companyId, taxType, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#updateCustomTaxes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyTaxRatesApi;

public class CompanyTaxRatesApiExample {

    public static void main(String[] args) {
        CompanyTaxRatesApi apiInstance = new CompanyTaxRatesApi();
        UUID companyId = companyId_example; // UUID | Company ID
        String taxType = taxType_example; // String | Tax Type
        CustomTaxTypeRate body = ; // CustomTaxTypeRate | Transaction Message
        try {
            apiInstance.updateCustomTaxes(companyId, taxType, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTaxRatesApi#updateCustomTaxes");
            e.printStackTrace();
        }
    }
}
UUID *companyId = companyId_example; // Company ID
String *taxType = taxType_example; // Tax Type
CustomTaxTypeRate *body = ; // Transaction Message

CompanyTaxRatesApi *apiInstance = [[CompanyTaxRatesApi alloc] init];

// Update custom agast for one company
[apiInstance updateCustomTaxesWith:companyId
    taxType:taxType
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.CompanyTaxRatesApi()

var companyId = companyId_example; // {UUID} Company ID

var taxType = taxType_example; // {String} Tax Type

var body = ; // {CustomTaxTypeRate} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCustomTaxes(companyIdtaxTypebody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCustomTaxesExample
    {
        public void main()
        {
            
            var apiInstance = new CompanyTaxRatesApi();
            var companyId = companyId_example;  // UUID | Company ID
            var taxType = taxType_example;  // String | Tax Type
            var body = new CustomTaxTypeRate(); // CustomTaxTypeRate | Transaction Message

            try
            {
                // Update custom agast for one company
                apiInstance.updateCustomTaxes(companyId, taxType, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyTaxRatesApi.updateCustomTaxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CompanyTaxRatesApi();
$companyId = companyId_example; // UUID | Company ID
$taxType = taxType_example; // String | Tax Type
$body = ; // CustomTaxTypeRate | Transaction Message

try {
    $api_instance->updateCustomTaxes($companyId, $taxType, $body);
} catch (Exception $e) {
    echo 'Exception when calling CompanyTaxRatesApi->updateCustomTaxes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
companyId*
taxType*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


GoodsCalculations

calculationsgoodsPurchasePost

Calculation Method

This method has more the one operation model, (a) simple calculation, this mode has a minimal validation and mandatory field, only enough for calc; (b) full calculation, simulation, this mode the system will check all atributes and calc all taxes for that transaction; (c) full calculation, starting process to transform this this request into transaction (for NFe, NFCe, CT-e need government authorization); (d) ASIS, the sistem receive the message, store and try get authorization, model valid only form NFe, NFCe and CT-e.


/calculations?goods-purchase

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations?goods-purchase"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GoodsCalculationsApi;

import java.io.File;
import java.util.*;

public class GoodsCalculationsApiExample {

    public static void main(String[] args) {
        
        GoodsCalculationsApi apiInstance = new GoodsCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.calculationsgoodsPurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsCalculationsApi#calculationsgoodsPurchasePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GoodsCalculationsApi;

public class GoodsCalculationsApiExample {

    public static void main(String[] args) {
        GoodsCalculationsApi apiInstance = new GoodsCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.calculationsgoodsPurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsCalculationsApi#calculationsgoodsPurchasePost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
TransactionForGoodsIn *body = ; // Transaction Message

GoodsCalculationsApi *apiInstance = [[GoodsCalculationsApi alloc] init];

// Calculation Method
[apiInstance calculationsgoodsPurchasePostWith:authorization
    body:body
              completionHandler: ^(TransactionForGoodsOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.GoodsCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {TransactionForGoodsIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculationsgoodsPurchasePost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsgoodsPurchasePostExample
    {
        public void main()
        {
            
            var apiInstance = new GoodsCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new TransactionForGoodsIn(); // TransactionForGoodsIn | Transaction Message

            try
            {
                // Calculation Method
                TransactionForGoodsOut result = apiInstance.calculationsgoodsPurchasePost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GoodsCalculationsApi.calculationsgoodsPurchasePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GoodsCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // TransactionForGoodsIn | Transaction Message

try {
    $result = $api_instance->calculationsgoodsPurchasePost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsCalculationsApi->calculationsgoodsPurchasePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


calculationsgoodsSalesPost

Calculation Method

This method has more the one operation model, (a) simple calculation, this mode has a minimal validation and mandatory field, only enough for calc; (b) full calculation, simulation, this mode the system will check all atributes and calc all taxes for that transaction; (c) full calculation, starting process to transform this this request into transaction (for NFe, NFCe, CT-e need government authorization); (d) ASIS, the sistem receive the message, store and try get authorization, model valid only form NFe, NFCe and CT-e.


/calculations?goods-sales

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations?goods-sales"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GoodsCalculationsApi;

import java.io.File;
import java.util.*;

public class GoodsCalculationsApiExample {

    public static void main(String[] args) {
        
        GoodsCalculationsApi apiInstance = new GoodsCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.calculationsgoodsSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsCalculationsApi#calculationsgoodsSalesPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GoodsCalculationsApi;

public class GoodsCalculationsApiExample {

    public static void main(String[] args) {
        GoodsCalculationsApi apiInstance = new GoodsCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.calculationsgoodsSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsCalculationsApi#calculationsgoodsSalesPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
TransactionForGoodsIn *body = ; // Transaction Message

GoodsCalculationsApi *apiInstance = [[GoodsCalculationsApi alloc] init];

// Calculation Method
[apiInstance calculationsgoodsSalesPostWith:authorization
    body:body
              completionHandler: ^(TransactionForGoodsOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.GoodsCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {TransactionForGoodsIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculationsgoodsSalesPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsgoodsSalesPostExample
    {
        public void main()
        {
            
            var apiInstance = new GoodsCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new TransactionForGoodsIn(); // TransactionForGoodsIn | Transaction Message

            try
            {
                // Calculation Method
                TransactionForGoodsOut result = apiInstance.calculationsgoodsSalesPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GoodsCalculationsApi.calculationsgoodsSalesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GoodsCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // TransactionForGoodsIn | Transaction Message

try {
    $result = $api_instance->calculationsgoodsSalesPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsCalculationsApi->calculationsgoodsSalesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


GoodsTransactions

transactionsgoodsPurchasePost

Transaction Method

This method has more then one operation model, (a) AS IS, the system only stores the transaction; (b) Full Calculation, the system calculates taxes, validates fileds, stores with transaction state, but doesn't try get government authorization; (c) Full Sync, the system calculates taxes, validates fileds, gets government authorization, stores with transaction state when authorized, used for NFCe.


/transactions?goods-purchase

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions?goods-purchase"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GoodsTransactionsApi;

import java.io.File;
import java.util.*;

public class GoodsTransactionsApiExample {

    public static void main(String[] args) {
        
        GoodsTransactionsApi apiInstance = new GoodsTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.transactionsgoodsPurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsTransactionsApi#transactionsgoodsPurchasePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GoodsTransactionsApi;

public class GoodsTransactionsApiExample {

    public static void main(String[] args) {
        GoodsTransactionsApi apiInstance = new GoodsTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.transactionsgoodsPurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsTransactionsApi#transactionsgoodsPurchasePost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
TransactionForGoodsIn *body = ; // Transaction Message

GoodsTransactionsApi *apiInstance = [[GoodsTransactionsApi alloc] init];

// Transaction Method
[apiInstance transactionsgoodsPurchasePostWith:authorization
    body:body
              completionHandler: ^(TransactionForGoodsOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.GoodsTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {TransactionForGoodsIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transactionsgoodsPurchasePost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsgoodsPurchasePostExample
    {
        public void main()
        {
            
            var apiInstance = new GoodsTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new TransactionForGoodsIn(); // TransactionForGoodsIn | Transaction Message

            try
            {
                // Transaction Method
                TransactionForGoodsOut result = apiInstance.transactionsgoodsPurchasePost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GoodsTransactionsApi.transactionsgoodsPurchasePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GoodsTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // TransactionForGoodsIn | Transaction Message

try {
    $result = $api_instance->transactionsgoodsPurchasePost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsTransactionsApi->transactionsgoodsPurchasePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


transactionsgoodsSalesPost

Transaction Method

This method has more then one operation model, (a) AS IS, the system only stores the transaction; (b) Full Calculation, the system calculates taxes, validates fields, stores with transaction state, but doesn't try get government authorization; (c) Full Sync, the system calculates the taxes, validates fileds, gets government authorization, stores with transaction state when authorized, used for NFCe.


/transactions?goods-sales

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions?goods-sales"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GoodsTransactionsApi;

import java.io.File;
import java.util.*;

public class GoodsTransactionsApiExample {

    public static void main(String[] args) {
        
        GoodsTransactionsApi apiInstance = new GoodsTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.transactionsgoodsSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsTransactionsApi#transactionsgoodsSalesPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GoodsTransactionsApi;

public class GoodsTransactionsApiExample {

    public static void main(String[] args) {
        GoodsTransactionsApi apiInstance = new GoodsTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        TransactionForGoodsIn body = ; // TransactionForGoodsIn | Transaction Message
        try {
            TransactionForGoodsOut result = apiInstance.transactionsgoodsSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoodsTransactionsApi#transactionsgoodsSalesPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
TransactionForGoodsIn *body = ; // Transaction Message

GoodsTransactionsApi *apiInstance = [[GoodsTransactionsApi alloc] init];

// Transaction Method
[apiInstance transactionsgoodsSalesPostWith:authorization
    body:body
              completionHandler: ^(TransactionForGoodsOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.GoodsTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {TransactionForGoodsIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transactionsgoodsSalesPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsgoodsSalesPostExample
    {
        public void main()
        {
            
            var apiInstance = new GoodsTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new TransactionForGoodsIn(); // TransactionForGoodsIn | Transaction Message

            try
            {
                // Transaction Method
                TransactionForGoodsOut result = apiInstance.transactionsgoodsSalesPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GoodsTransactionsApi.transactionsgoodsSalesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GoodsTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // TransactionForGoodsIn | Transaction Message

try {
    $result = $api_instance->transactionsgoodsSalesPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GoodsTransactionsApi->transactionsgoodsSalesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


InvoiceContingency

invoiceDropContingency

Invoice Drop Contingency per State

Drop State in Contingency


/invoices/contingency/{state}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/contingency/{state}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceContingencyApi;

import java.io.File;
import java.util.*;

public class InvoiceContingencyApiExample {

    public static void main(String[] args) {
        
        InvoiceContingencyApi apiInstance = new InvoiceContingencyApi();
        String state = state_example; // String | Brazilian State
        try {
            apiInstance.invoiceDropContingency(state);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceContingencyApi#invoiceDropContingency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceContingencyApi;

public class InvoiceContingencyApiExample {

    public static void main(String[] args) {
        InvoiceContingencyApi apiInstance = new InvoiceContingencyApi();
        String state = state_example; // String | Brazilian State
        try {
            apiInstance.invoiceDropContingency(state);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceContingencyApi#invoiceDropContingency");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State

InvoiceContingencyApi *apiInstance = [[InvoiceContingencyApi alloc] init];

// Invoice Drop Contingency per State
[apiInstance invoiceDropContingencyWith:state
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceContingencyApi()

var state = state_example; // {String} Brazilian State


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.invoiceDropContingency(state, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoiceDropContingencyExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceContingencyApi();
            var state = state_example;  // String | Brazilian State

            try
            {
                // Invoice Drop Contingency per State
                apiInstance.invoiceDropContingency(state);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceContingencyApi.invoiceDropContingency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceContingencyApi();
$state = state_example; // String | Brazilian State

try {
    $api_instance->invoiceDropContingency($state);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceContingencyApi->invoiceDropContingency: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoiceSetContingency

Invoice Set Contingency per State

Set State in Contingency


/invoices/contingency/{state}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/contingency/{state}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceContingencyApi;

import java.io.File;
import java.util.*;

public class InvoiceContingencyApiExample {

    public static void main(String[] args) {
        
        InvoiceContingencyApi apiInstance = new InvoiceContingencyApi();
        String state = state_example; // String | Brazilian State
        Body_4 body = ; // Body_4 | Set Contingency
        try {
            apiInstance.invoiceSetContingency(state, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceContingencyApi#invoiceSetContingency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceContingencyApi;

public class InvoiceContingencyApiExample {

    public static void main(String[] args) {
        InvoiceContingencyApi apiInstance = new InvoiceContingencyApi();
        String state = state_example; // String | Brazilian State
        Body_4 body = ; // Body_4 | Set Contingency
        try {
            apiInstance.invoiceSetContingency(state, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceContingencyApi#invoiceSetContingency");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State
Body_4 *body = ; // Set Contingency

InvoiceContingencyApi *apiInstance = [[InvoiceContingencyApi alloc] init];

// Invoice Set Contingency per State
[apiInstance invoiceSetContingencyWith:state
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceContingencyApi()

var state = state_example; // {String} Brazilian State

var body = ; // {Body_4} Set Contingency


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.invoiceSetContingency(state, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoiceSetContingencyExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceContingencyApi();
            var state = state_example;  // String | Brazilian State
            var body = new Body_4(); // Body_4 | Set Contingency

            try
            {
                // Invoice Set Contingency per State
                apiInstance.invoiceSetContingency(state, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceContingencyApi.invoiceSetContingency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceContingencyApi();
$state = state_example; // String | Brazilian State
$body = ; // Body_4 | Set Contingency

try {
    $api_instance->invoiceSetContingency($state, $body);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceContingencyApi->invoiceSetContingency: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*
Body parameters
Name Description
body *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoiceVerifyContingency

Invoice Verify Contingency per State

Check if State was in Contingency


/invoices/contingency/{state}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/contingency/{state}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceContingencyApi;

import java.io.File;
import java.util.*;

public class InvoiceContingencyApiExample {

    public static void main(String[] args) {
        
        InvoiceContingencyApi apiInstance = new InvoiceContingencyApi();
        String state = state_example; // String | Brazilian State
        try {
            inline_response_200_3 result = apiInstance.invoiceVerifyContingency(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceContingencyApi#invoiceVerifyContingency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceContingencyApi;

public class InvoiceContingencyApiExample {

    public static void main(String[] args) {
        InvoiceContingencyApi apiInstance = new InvoiceContingencyApi();
        String state = state_example; // String | Brazilian State
        try {
            inline_response_200_3 result = apiInstance.invoiceVerifyContingency(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceContingencyApi#invoiceVerifyContingency");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State

InvoiceContingencyApi *apiInstance = [[InvoiceContingencyApi alloc] init];

// Invoice Verify Contingency per State
[apiInstance invoiceVerifyContingencyWith:state
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceContingencyApi()

var state = state_example; // {String} Brazilian State


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoiceVerifyContingency(state, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoiceVerifyContingencyExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceContingencyApi();
            var state = state_example;  // String | Brazilian State

            try
            {
                // Invoice Verify Contingency per State
                inline_response_200_3 result = apiInstance.invoiceVerifyContingency(state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceContingencyApi.invoiceVerifyContingency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceContingencyApi();
$state = state_example; // String | Brazilian State

try {
    $result = $api_instance->invoiceVerifyContingency($state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceContingencyApi->invoiceVerifyContingency: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*

Responses

Status: 200 - Contingency Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


InvoiceNFCeDANFE

invoicesNfceKeyGet

NFCe Danfe Print

Retrieve the Danfe in NFCe format.


/invoices/nfce/{key}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/nfce/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceNFCeDANFEApi;

import java.io.File;
import java.util.*;

public class InvoiceNFCeDANFEApiExample {

    public static void main(String[] args) {
        
        InvoiceNFCeDANFEApi apiInstance = new InvoiceNFCeDANFEApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            File result = apiInstance.invoicesNfceKeyGet(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceNFCeDANFEApi#invoicesNfceKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceNFCeDANFEApi;

public class InvoiceNFCeDANFEApiExample {

    public static void main(String[] args) {
        InvoiceNFCeDANFEApi apiInstance = new InvoiceNFCeDANFEApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            File result = apiInstance.invoicesNfceKeyGet(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceNFCeDANFEApi#invoicesNfceKeyGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
String *key = key_example; // Invoice Key

InvoiceNFCeDANFEApi *apiInstance = [[InvoiceNFCeDANFEApi alloc] init];

// NFCe Danfe Print
[apiInstance invoicesNfceKeyGetWith:authorization
    key:key
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceNFCeDANFEApi()

var authorization = authorization_example; // {String} Bearer {auth}

var key = key_example; // {String} Invoice Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesNfceKeyGet(authorization, key, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesNfceKeyGetExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceNFCeDANFEApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var key = key_example;  // String | Invoice Key

            try
            {
                // NFCe Danfe Print
                File result = apiInstance.invoicesNfceKeyGet(authorization, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceNFCeDANFEApi.invoicesNfceKeyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceNFCeDANFEApi();
$authorization = authorization_example; // String | Bearer {auth}
$key = key_example; // String | Invoice Key

try {
    $result = $api_instance->invoicesNfceKeyGet($authorization, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceNFCeDANFEApi->invoicesNfceKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
key*
Header parameters
Name Description
authorization*

Responses

Status: 200 - NFC-e DANFE

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


InvoiceNFeDANFE

nfePrint

Retrieve Danfe

Retrieve the Danfe


/invoices/nfe/{key}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/nfe/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceNFeDANFEApi;

import java.io.File;
import java.util.*;

public class InvoiceNFeDANFEApiExample {

    public static void main(String[] args) {
        
        InvoiceNFeDANFEApi apiInstance = new InvoiceNFeDANFEApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            File result = apiInstance.nfePrint(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceNFeDANFEApi#nfePrint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceNFeDANFEApi;

public class InvoiceNFeDANFEApiExample {

    public static void main(String[] args) {
        InvoiceNFeDANFEApi apiInstance = new InvoiceNFeDANFEApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            File result = apiInstance.nfePrint(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceNFeDANFEApi#nfePrint");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
String *key = key_example; // Invoice Key

InvoiceNFeDANFEApi *apiInstance = [[InvoiceNFeDANFEApi alloc] init];

// Retrieve Danfe
[apiInstance nfePrintWith:authorization
    key:key
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceNFeDANFEApi()

var authorization = authorization_example; // {String} Bearer {auth}

var key = key_example; // {String} Invoice Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nfePrint(authorization, key, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nfePrintExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceNFeDANFEApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var key = key_example;  // String | Invoice Key

            try
            {
                // Retrieve Danfe
                File result = apiInstance.nfePrint(authorization, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceNFeDANFEApi.nfePrint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceNFeDANFEApi();
$authorization = authorization_example; // String | Bearer {auth}
$key = key_example; // String | Invoice Key

try {
    $result = $api_instance->nfePrint($authorization, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceNFeDANFEApi->nfePrint: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
key*
Header parameters
Name Description
authorization*

Responses

Status: 200 - NF-e DANFE

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


InvoiceSEFAZ

invoicesSefazDelete

Disable Range e-Invoice

Send disable range of NFes to SEFAZ


/invoices/sefaz

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/sefaz"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSEFAZApi;

import java.io.File;
import java.util.*;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        SefazDisableRangeIn body = ; // SefazDisableRangeIn | Disable Range e-Invoice
        try {
            SefazInvoiceBasicStatus result = apiInstance.invoicesSefazDelete(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSEFAZApi;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        SefazDisableRangeIn body = ; // SefazDisableRangeIn | Disable Range e-Invoice
        try {
            SefazInvoiceBasicStatus result = apiInstance.invoicesSefazDelete(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazDelete");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
SefazDisableRangeIn *body = ; // Disable Range e-Invoice

InvoiceSEFAZApi *apiInstance = [[InvoiceSEFAZApi alloc] init];

// Disable Range e-Invoice
[apiInstance invoicesSefazDeleteWith:authorization
    body:body
              completionHandler: ^(SefazInvoiceBasicStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSEFAZApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {SefazDisableRangeIn} Disable Range e-Invoice


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesSefazDelete(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesSefazDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSEFAZApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new SefazDisableRangeIn(); // SefazDisableRangeIn | Disable Range e-Invoice

            try
            {
                // Disable Range e-Invoice
                SefazInvoiceBasicStatus result = apiInstance.invoicesSefazDelete(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSEFAZApi.invoicesSefazDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSEFAZApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // SefazDisableRangeIn | Disable Range e-Invoice

try {
    $result = $api_instance->invoicesSefazDelete($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSEFAZApi->invoicesSefazDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Return Sefaz

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoicesSefazKeyDelete

Cancel invoice

Cancel the invoice


/invoices/sefaz/{key}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/sefaz/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSEFAZApi;

import java.io.File;
import java.util.*;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        SefazItDeleteIn body = ; // SefazItDeleteIn | Cancel Message
        try {
            SefazInvoiceBasicStatus result = apiInstance.invoicesSefazKeyDelete(authorization, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSEFAZApi;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        SefazItDeleteIn body = ; // SefazItDeleteIn | Cancel Message
        try {
            SefazInvoiceBasicStatus result = apiInstance.invoicesSefazKeyDelete(authorization, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyDelete");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
String *key = key_example; // Invoice Key
SefazItDeleteIn *body = ; // Cancel Message

InvoiceSEFAZApi *apiInstance = [[InvoiceSEFAZApi alloc] init];

// Cancel invoice
[apiInstance invoicesSefazKeyDeleteWith:authorization
    key:key
    body:body
              completionHandler: ^(SefazInvoiceBasicStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSEFAZApi()

var authorization = authorization_example; // {String} Bearer {auth}

var key = key_example; // {String} Invoice Key

var body = ; // {SefazItDeleteIn} Cancel Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesSefazKeyDelete(authorization, keybody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesSefazKeyDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSEFAZApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var key = key_example;  // String | Invoice Key
            var body = new SefazItDeleteIn(); // SefazItDeleteIn | Cancel Message

            try
            {
                // Cancel invoice
                SefazInvoiceBasicStatus result = apiInstance.invoicesSefazKeyDelete(authorization, key, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSEFAZApi.invoicesSefazKeyDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSEFAZApi();
$authorization = authorization_example; // String | Bearer {auth}
$key = key_example; // String | Invoice Key
$body = ; // SefazItDeleteIn | Cancel Message

try {
    $result = $api_instance->invoicesSefazKeyDelete($authorization, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSEFAZApi->invoicesSefazKeyDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
key*
Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Cancel Invoice Status

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoicesSefazKeyGet

Retrieve invoice

Retrieve the invoice


/invoices/sefaz/{key}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/sefaz/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSEFAZApi;

import java.io.File;
import java.util.*;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            SefazItGetOut result = apiInstance.invoicesSefazKeyGet(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSEFAZApi;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            SefazItGetOut result = apiInstance.invoicesSefazKeyGet(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
String *key = key_example; // Invoice Key

InvoiceSEFAZApi *apiInstance = [[InvoiceSEFAZApi alloc] init];

// Retrieve invoice
[apiInstance invoicesSefazKeyGetWith:authorization
    key:key
              completionHandler: ^(SefazItGetOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSEFAZApi()

var authorization = authorization_example; // {String} Bearer {auth}

var key = key_example; // {String} Invoice Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesSefazKeyGet(authorization, key, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesSefazKeyGetExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSEFAZApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var key = key_example;  // String | Invoice Key

            try
            {
                // Retrieve invoice
                SefazItGetOut result = apiInstance.invoicesSefazKeyGet(authorization, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSEFAZApi.invoicesSefazKeyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSEFAZApi();
$authorization = authorization_example; // String | Bearer {auth}
$key = key_example; // String | Invoice Key

try {
    $result = $api_instance->invoicesSefazKeyGet($authorization, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSEFAZApi->invoicesSefazKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
key*
Header parameters
Name Description
authorization*

Responses

Status: 200 - Invoice Data

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoicesSefazKeyLookupGet

Retrieve invoice

Retrieve the invoice


/invoices/sefaz/{key}/lookup

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/sefaz/{key}/lookup"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSEFAZApi;

import java.io.File;
import java.util.*;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            TransactionForSefazGoodsList result = apiInstance.invoicesSefazKeyLookupGet(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyLookupGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSEFAZApi;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        try {
            TransactionForSefazGoodsList result = apiInstance.invoicesSefazKeyLookupGet(authorization, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyLookupGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
String *key = key_example; // Invoice Key

InvoiceSEFAZApi *apiInstance = [[InvoiceSEFAZApi alloc] init];

// Retrieve invoice
[apiInstance invoicesSefazKeyLookupGetWith:authorization
    key:key
              completionHandler: ^(TransactionForSefazGoodsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSEFAZApi()

var authorization = authorization_example; // {String} Bearer {auth}

var key = key_example; // {String} Invoice Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesSefazKeyLookupGet(authorization, key, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesSefazKeyLookupGetExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSEFAZApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var key = key_example;  // String | Invoice Key

            try
            {
                // Retrieve invoice
                TransactionForSefazGoodsList result = apiInstance.invoicesSefazKeyLookupGet(authorization, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSEFAZApi.invoicesSefazKeyLookupGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSEFAZApi();
$authorization = authorization_example; // String | Bearer {auth}
$key = key_example; // String | Invoice Key

try {
    $result = $api_instance->invoicesSefazKeyLookupGet($authorization, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSEFAZApi->invoicesSefazKeyLookupGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
key*
Header parameters
Name Description
authorization*

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoicesSefazKeyPut

Fix Letter

Fix Letter


/invoices/sefaz/{key}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/sefaz/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSEFAZApi;

import java.io.File;
import java.util.*;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        SefazItPutIn body = ; // SefazItPutIn | Fix Message
        try {
            SefazInvoiceBasicStatus result = apiInstance.invoicesSefazKeyPut(authorization, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSEFAZApi;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        String key = key_example; // String | Invoice Key
        SefazItPutIn body = ; // SefazItPutIn | Fix Message
        try {
            SefazInvoiceBasicStatus result = apiInstance.invoicesSefazKeyPut(authorization, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazKeyPut");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
String *key = key_example; // Invoice Key
SefazItPutIn *body = ; // Fix Message

InvoiceSEFAZApi *apiInstance = [[InvoiceSEFAZApi alloc] init];

// Fix Letter
[apiInstance invoicesSefazKeyPutWith:authorization
    key:key
    body:body
              completionHandler: ^(SefazInvoiceBasicStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSEFAZApi()

var authorization = authorization_example; // {String} Bearer {auth}

var key = key_example; // {String} Invoice Key

var body = ; // {SefazItPutIn} Fix Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesSefazKeyPut(authorization, keybody, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesSefazKeyPutExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSEFAZApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var key = key_example;  // String | Invoice Key
            var body = new SefazItPutIn(); // SefazItPutIn | Fix Message

            try
            {
                // Fix Letter
                SefazInvoiceBasicStatus result = apiInstance.invoicesSefazKeyPut(authorization, key, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSEFAZApi.invoicesSefazKeyPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSEFAZApi();
$authorization = authorization_example; // String | Bearer {auth}
$key = key_example; // String | Invoice Key
$body = ; // SefazItPutIn | Fix Message

try {
    $result = $api_instance->invoicesSefazKeyPut($authorization, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSEFAZApi->invoicesSefazKeyPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
key*
Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Fix Letter Status

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoicesSefazPost

Send an e-Invoice

Send a invoice to SEFAZ


/invoices/sefaz

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/sefaz"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSEFAZApi;

import java.io.File;
import java.util.*;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        array[TransactionForSefazGoods] body = ; // array[TransactionForSefazGoods] | Invoices
        try {
            SefazPostOut result = apiInstance.invoicesSefazPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSEFAZApi;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        array[TransactionForSefazGoods] body = ; // array[TransactionForSefazGoods] | Invoices
        try {
            SefazPostOut result = apiInstance.invoicesSefazPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
array[TransactionForSefazGoods] *body = ; // Invoices

InvoiceSEFAZApi *apiInstance = [[InvoiceSEFAZApi alloc] init];

// Send an e-Invoice
[apiInstance invoicesSefazPostWith:authorization
    body:body
              completionHandler: ^(SefazPostOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSEFAZApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {array[TransactionForSefazGoods]} Invoices


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesSefazPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesSefazPostExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSEFAZApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new array[TransactionForSefazGoods](); // array[TransactionForSefazGoods] | Invoices

            try
            {
                // Send an e-Invoice
                SefazPostOut result = apiInstance.invoicesSefazPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSEFAZApi.invoicesSefazPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSEFAZApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // array[TransactionForSefazGoods] | Invoices

try {
    $result = $api_instance->invoicesSefazPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSEFAZApi->invoicesSefazPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Sefaz Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


invoicesSefazStatusGet

Retrieve Status of SEFAZ Server

Retrieve Status of SEFAZ Server


/invoices/sefaz/status

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/sefaz/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSEFAZApi;

import java.io.File;
import java.util.*;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        try {
            'String' result = apiInstance.invoicesSefazStatusGet(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSEFAZApi;

public class InvoiceSEFAZApiExample {

    public static void main(String[] args) {
        InvoiceSEFAZApi apiInstance = new InvoiceSEFAZApi();
        String authorization = authorization_example; // String | Bearer {auth}
        try {
            'String' result = apiInstance.invoicesSefazStatusGet(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSEFAZApi#invoicesSefazStatusGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}

InvoiceSEFAZApi *apiInstance = [[InvoiceSEFAZApi alloc] init];

// Retrieve Status of SEFAZ Server
[apiInstance invoicesSefazStatusGetWith:authorization
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSEFAZApi()

var authorization = authorization_example; // {String} Bearer {auth}


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoicesSefazStatusGet(authorization, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoicesSefazStatusGetExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSEFAZApi();
            var authorization = authorization_example;  // String | Bearer {auth}

            try
            {
                // Retrieve Status of SEFAZ Server
                'String' result = apiInstance.invoicesSefazStatusGet(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSEFAZApi.invoicesSefazStatusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSEFAZApi();
$authorization = authorization_example; // String | Bearer {auth}

try {
    $result = $api_instance->invoicesSefazStatusGet($authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSEFAZApi->invoicesSefazStatusGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


InvoiceSettings

invoiceSettings

Invoice Settigns

Get Enviroment Settigns


/invoices/settings

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/invoices/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvoiceSettingsApi;

import java.io.File;
import java.util.*;

public class InvoiceSettingsApiExample {

    public static void main(String[] args) {
        
        InvoiceSettingsApi apiInstance = new InvoiceSettingsApi();
        try {
            inline_response_200_4 result = apiInstance.invoiceSettings();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSettingsApi#invoiceSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvoiceSettingsApi;

public class InvoiceSettingsApiExample {

    public static void main(String[] args) {
        InvoiceSettingsApi apiInstance = new InvoiceSettingsApi();
        try {
            inline_response_200_4 result = apiInstance.invoiceSettings();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceSettingsApi#invoiceSettings");
            e.printStackTrace();
        }
    }
}

InvoiceSettingsApi *apiInstance = [[InvoiceSettingsApi alloc] init];

// Invoice Settigns
[apiInstance invoiceSettingsWithCompletionHandler: 
              ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.InvoiceSettingsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invoiceSettings(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invoiceSettingsExample
    {
        public void main()
        {
            
            var apiInstance = new InvoiceSettingsApi();

            try
            {
                // Invoice Settigns
                inline_response_200_4 result = apiInstance.invoiceSettings();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InvoiceSettingsApi.invoiceSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InvoiceSettingsApi();

try {
    $result = $api_instance->invoiceSettings();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceSettingsApi->invoiceSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


LegalReason

createReason.

Create Legal Reason.


/taxconf/legal-reason

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/legal-reason"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalReasonApi;

import java.io.File;
import java.util.*;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        
        LegalReasonApi apiInstance = new LegalReasonApi();
        LegalReason body = ; // LegalReason | 
        try {
            inline_response_201 result = apiInstance.createReason.(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#createReason.");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalReasonApi;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        LegalReasonApi apiInstance = new LegalReasonApi();
        LegalReason body = ; // LegalReason | 
        try {
            inline_response_201 result = apiInstance.createReason.(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#createReason.");
            e.printStackTrace();
        }
    }
}
LegalReason *body = ; // 

LegalReasonApi *apiInstance = [[LegalReasonApi alloc] init];

// Create Legal Reason.
[apiInstance createReason.With:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.LegalReasonApi()

var body = ; // {LegalReason} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createReason.(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createReason.Example
    {
        public void main()
        {
            
            var apiInstance = new LegalReasonApi();
            var body = new LegalReason(); // LegalReason | 

            try
            {
                // Create Legal Reason.
                inline_response_201 result = apiInstance.createReason.(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalReasonApi.createReason.: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LegalReasonApi();
$body = ; // LegalReason | 

try {
    $result = $api_instance->createReason.($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegalReasonApi->createReason.: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Success.


deleteReason.

Delete a Legal Reason entry.


/taxconf/legal-reason/{uuid}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/legal-reason/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalReasonApi;

import java.io.File;
import java.util.*;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        
        LegalReasonApi apiInstance = new LegalReasonApi();
        String uuid = uuid_example; // String | 
        try {
            apiInstance.deleteReason.(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#deleteReason.");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalReasonApi;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        LegalReasonApi apiInstance = new LegalReasonApi();
        String uuid = uuid_example; // String | 
        try {
            apiInstance.deleteReason.(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#deleteReason.");
            e.printStackTrace();
        }
    }
}
String *uuid = uuid_example; // 

LegalReasonApi *apiInstance = [[LegalReasonApi alloc] init];

// Delete a Legal Reason entry.
[apiInstance deleteReason.With:uuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.LegalReasonApi()

var uuid = uuid_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteReason.(uuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteReason.Example
    {
        public void main()
        {
            
            var apiInstance = new LegalReasonApi();
            var uuid = uuid_example;  // String | 

            try
            {
                // Delete a Legal Reason entry.
                apiInstance.deleteReason.(uuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalReasonApi.deleteReason.: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LegalReasonApi();
$uuid = uuid_example; // String | 

try {
    $api_instance->deleteReason.($uuid);
} catch (Exception $e) {
    echo 'Exception when calling LegalReasonApi->deleteReason.: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 204 - Success.


getReason.

Get single Legal Reason.


/taxconf/legal-reason/{uuid}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/legal-reason/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalReasonApi;

import java.io.File;
import java.util.*;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        
        LegalReasonApi apiInstance = new LegalReasonApi();
        String uuid = uuid_example; // String | 
        try {
            ProcessScenario result = apiInstance.getReason.(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#getReason.");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalReasonApi;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        LegalReasonApi apiInstance = new LegalReasonApi();
        String uuid = uuid_example; // String | 
        try {
            ProcessScenario result = apiInstance.getReason.(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#getReason.");
            e.printStackTrace();
        }
    }
}
String *uuid = uuid_example; // 

LegalReasonApi *apiInstance = [[LegalReasonApi alloc] init];

// Get single Legal Reason.
[apiInstance getReason.With:uuid
              completionHandler: ^(ProcessScenario output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.LegalReasonApi()

var uuid = uuid_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReason.(uuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReason.Example
    {
        public void main()
        {
            
            var apiInstance = new LegalReasonApi();
            var uuid = uuid_example;  // String | 

            try
            {
                // Get single Legal Reason.
                ProcessScenario result = apiInstance.getReason.(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalReasonApi.getReason.: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LegalReasonApi();
$uuid = uuid_example; // String | 

try {
    $result = $api_instance->getReason.($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegalReasonApi->getReason.: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - Successful response


listReason

List Legal Reasons.


/taxconf/legal-reason

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/legal-reason?companyId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalReasonApi;

import java.io.File;
import java.util.*;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        
        LegalReasonApi apiInstance = new LegalReasonApi();
        String companyId = companyId_example; // String | Filters by company domain entries.
Provide "global" to retrive only "global" entries.
CompanyId searches also match global entries.

        try {
            array[LegalReason] result = apiInstance.listReason(companyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#listReason");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalReasonApi;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        LegalReasonApi apiInstance = new LegalReasonApi();
        String companyId = companyId_example; // String | Filters by company domain entries.
Provide "global" to retrive only "global" entries.
CompanyId searches also match global entries.

        try {
            array[LegalReason] result = apiInstance.listReason(companyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#listReason");
            e.printStackTrace();
        }
    }
}
String *companyId = companyId_example; // Filters by company domain entries.
Provide "global" to retrive only "global" entries.
CompanyId searches also match global entries.
 (optional)

LegalReasonApi *apiInstance = [[LegalReasonApi alloc] init];

// List Legal Reasons.
[apiInstance listReasonWith:companyId
              completionHandler: ^(array[LegalReason] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.LegalReasonApi()

var opts = { 
  'companyId': companyId_example // {String} Filters by company domain entries.
Provide "global" to retrive only "global" entries.
CompanyId searches also match global entries.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listReason(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listReasonExample
    {
        public void main()
        {
            
            var apiInstance = new LegalReasonApi();
            var companyId = companyId_example;  // String | Filters by company domain entries.
Provide "global" to retrive only "global" entries.
CompanyId searches also match global entries.
 (optional) 

            try
            {
                // List Legal Reasons.
                array[LegalReason] result = apiInstance.listReason(companyId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalReasonApi.listReason: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LegalReasonApi();
$companyId = companyId_example; // String | Filters by company domain entries.
Provide "global" to retrive only "global" entries.
CompanyId searches also match global entries.


try {
    $result = $api_instance->listReason($companyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegalReasonApi->listReason: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
companyId

Responses

Status: 200 - Success response


updateReason.

Update Legal Reason.


/taxconf/legal-reason

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/legal-reason"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalReasonApi;

import java.io.File;
import java.util.*;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        
        LegalReasonApi apiInstance = new LegalReasonApi();
        LegalReason body = ; // LegalReason | 
        try {
            apiInstance.updateReason.(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#updateReason.");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalReasonApi;

public class LegalReasonApiExample {

    public static void main(String[] args) {
        LegalReasonApi apiInstance = new LegalReasonApi();
        LegalReason body = ; // LegalReason | 
        try {
            apiInstance.updateReason.(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalReasonApi#updateReason.");
            e.printStackTrace();
        }
    }
}
LegalReason *body = ; // 

LegalReasonApi *apiInstance = [[LegalReasonApi alloc] init];

// Update Legal Reason.
[apiInstance updateReason.With:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.LegalReasonApi()

var body = ; // {LegalReason} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateReason.(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateReason.Example
    {
        public void main()
        {
            
            var apiInstance = new LegalReasonApi();
            var body = new LegalReason(); // LegalReason | 

            try
            {
                // Update Legal Reason.
                apiInstance.updateReason.(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalReasonApi.updateReason.: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LegalReasonApi();
$body = ; // LegalReason | 

try {
    $api_instance->updateReason.($body);
} catch (Exception $e) {
    echo 'Exception when calling LegalReasonApi->updateReason.: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
body *

Responses

Status: 204 - Success.


ServiceCalculations

calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet

Retrieve transactions

Retrieve a single transaction


/calculations/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceCalculationsApi;

import java.io.File;
import java.util.*;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        try {
            apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceCalculationsApi;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        try {
            apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
UUID *accountId = accountId_example; // Account ID
String *companyCode = companyCode_example; // Company Code
String *transactionType = transactionType_example; // Transaction Type (sale, purchase, receipts or payment)
String *documentCode = documentCode_example; // Document Code

ServiceCalculationsApi *apiInstance = [[ServiceCalculationsApi alloc] init];

// Retrieve transactions
[apiInstance calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGetWith:authorization
    accountId:accountId
    companyCode:companyCode
    transactionType:transactionType
    documentCode:documentCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var accountId = accountId_example; // {UUID} Account ID

var companyCode = companyCode_example; // {String} Company Code

var transactionType = transactionType_example; // {String} Transaction Type (sale, purchase, receipts or payment)

var documentCode = documentCode_example; // {String} Document Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGetExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var accountId = accountId_example;  // UUID | Account ID
            var companyCode = companyCode_example;  // String | Company Code
            var transactionType = transactionType_example;  // String | Transaction Type (sale, purchase, receipts or payment)
            var documentCode = documentCode_example;  // String | Document Code

            try
            {
                // Retrieve transactions
                apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceCalculationsApi.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$accountId = accountId_example; // UUID | Account ID
$companyCode = companyCode_example; // String | Company Code
$transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
$documentCode = documentCode_example; // String | Document Code

try {
    $api_instance->calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet($authorization, $accountId, $companyCode, $transactionType, $documentCode);
} catch (Exception $e) {
    echo 'Exception when calling ServiceCalculationsApi->calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
companyCode*
transactionType*
documentCode*
Header parameters
Name Description
authorization*

Responses

Status: 200 - List of transaction

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost

Promote a calculation to transaction

Promote a calculation to transaction


/calculations/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}/transactions

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}/transactions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceCalculationsApi;

import java.io.File;
import java.util.*;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        try {
            apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost(authorization, accountId, companyCode, transactionType, documentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceCalculationsApi;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        try {
            apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost(authorization, accountId, companyCode, transactionType, documentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
UUID *accountId = accountId_example; // Account ID
String *companyCode = companyCode_example; // Company Code
String *transactionType = transactionType_example; // Transaction Type (sale, purchase, receipts or payment)
String *documentCode = documentCode_example; // Document Code

ServiceCalculationsApi *apiInstance = [[ServiceCalculationsApi alloc] init];

// Promote a calculation to transaction
[apiInstance calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPostWith:authorization
    accountId:accountId
    companyCode:companyCode
    transactionType:transactionType
    documentCode:documentCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var accountId = accountId_example; // {UUID} Account ID

var companyCode = companyCode_example; // {String} Company Code

var transactionType = transactionType_example; // {String} Transaction Type (sale, purchase, receipts or payment)

var documentCode = documentCode_example; // {String} Document Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost(authorization, accountId, companyCode, transactionType, documentCode, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var accountId = accountId_example;  // UUID | Account ID
            var companyCode = companyCode_example;  // String | Company Code
            var transactionType = transactionType_example;  // String | Transaction Type (sale, purchase, receipts or payment)
            var documentCode = documentCode_example;  // String | Document Code

            try
            {
                // Promote a calculation to transaction
                apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost(authorization, accountId, companyCode, transactionType, documentCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceCalculationsApi.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$accountId = accountId_example; // UUID | Account ID
$companyCode = companyCode_example; // String | Company Code
$transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
$documentCode = documentCode_example; // String | Document Code

try {
    $api_instance->calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost($authorization, $accountId, $companyCode, $transactionType, $documentCode);
} catch (Exception $e) {
    echo 'Exception when calling ServiceCalculationsApi->calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeTransactionsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
companyCode*
transactionType*
documentCode*
Header parameters
Name Description
authorization*

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet

Retrieve transactions

Retrieve a list of transactions


/calculations/account/{accountId}/company/{companyCode}/{transactionType}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations/account/{accountId}/company/{companyCode}/{transactionType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceCalculationsApi;

import java.io.File;
import java.util.*;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        try {
            apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceCalculationsApi;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        try {
            apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
UUID *accountId = accountId_example; // Account ID
String *companyCode = companyCode_example; // Company Code
String *transactionType = transactionType_example; // Transaction Type (sale, purchase, receipts or payment)

ServiceCalculationsApi *apiInstance = [[ServiceCalculationsApi alloc] init];

// Retrieve transactions
[apiInstance calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGetWith:authorization
    accountId:accountId
    companyCode:companyCode
    transactionType:transactionType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var accountId = accountId_example; // {UUID} Account ID

var companyCode = companyCode_example; // {String} Company Code

var transactionType = transactionType_example; // {String} Transaction Type (sale, purchase, receipts or payment)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGetExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var accountId = accountId_example;  // UUID | Account ID
            var companyCode = companyCode_example;  // String | Company Code
            var transactionType = transactionType_example;  // String | Transaction Type (sale, purchase, receipts or payment)

            try
            {
                // Retrieve transactions
                apiInstance.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceCalculationsApi.calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$accountId = accountId_example; // UUID | Account ID
$companyCode = companyCode_example; // String | Company Code
$transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)

try {
    $api_instance->calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet($authorization, $accountId, $companyCode, $transactionType);
} catch (Exception $e) {
    echo 'Exception when calling ServiceCalculationsApi->calculationsAccountAccountIdCompanyCompanyCodeTransactionTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
companyCode*
transactionType*
Header parameters
Name Description
authorization*

Responses

Status: 200 - List of transaction

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


calculationsservicePaymentPost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned.


/calculations?service-payment

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations?service-payment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceCalculationsApi;

import java.io.File;
import java.util.*;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PaymentTransactionIn body = ; // PaymentTransactionIn | Transaction Message
        try {
            PaymentTransactionOut result = apiInstance.calculationsservicePaymentPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsservicePaymentPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceCalculationsApi;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PaymentTransactionIn body = ; // PaymentTransactionIn | Transaction Message
        try {
            PaymentTransactionOut result = apiInstance.calculationsservicePaymentPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsservicePaymentPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
PaymentTransactionIn *body = ; // Transaction Message

ServiceCalculationsApi *apiInstance = [[ServiceCalculationsApi alloc] init];

// Calculation Method
[apiInstance calculationsservicePaymentPostWith:authorization
    body:body
              completionHandler: ^(PaymentTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {PaymentTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculationsservicePaymentPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsservicePaymentPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new PaymentTransactionIn(); // PaymentTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                PaymentTransactionOut result = apiInstance.calculationsservicePaymentPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceCalculationsApi.calculationsservicePaymentPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // PaymentTransactionIn | Transaction Message

try {
    $result = $api_instance->calculationsservicePaymentPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceCalculationsApi->calculationsservicePaymentPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


calculationsservicePurchasePost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned.


/calculations?service-purchase

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations?service-purchase"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceCalculationsApi;

import java.io.File;
import java.util.*;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PurchaseTransactionIn body = ; // PurchaseTransactionIn | Transaction Message
        try {
            PurchaseTransactionOut result = apiInstance.calculationsservicePurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsservicePurchasePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceCalculationsApi;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PurchaseTransactionIn body = ; // PurchaseTransactionIn | Transaction Message
        try {
            PurchaseTransactionOut result = apiInstance.calculationsservicePurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsservicePurchasePost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
PurchaseTransactionIn *body = ; // Transaction Message

ServiceCalculationsApi *apiInstance = [[ServiceCalculationsApi alloc] init];

// Calculation Method
[apiInstance calculationsservicePurchasePostWith:authorization
    body:body
              completionHandler: ^(PurchaseTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {PurchaseTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculationsservicePurchasePost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsservicePurchasePostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new PurchaseTransactionIn(); // PurchaseTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                PurchaseTransactionOut result = apiInstance.calculationsservicePurchasePost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceCalculationsApi.calculationsservicePurchasePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // PurchaseTransactionIn | Transaction Message

try {
    $result = $api_instance->calculationsservicePurchasePost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceCalculationsApi->calculationsservicePurchasePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


calculationsserviceReceiptPost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned.


/calculations?service-receipt

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations?service-receipt"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceCalculationsApi;

import java.io.File;
import java.util.*;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        ReceiptTransactionIn body = ; // ReceiptTransactionIn | Transaction Message
        try {
            ReceiptTransactionOut result = apiInstance.calculationsserviceReceiptPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsserviceReceiptPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceCalculationsApi;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        ReceiptTransactionIn body = ; // ReceiptTransactionIn | Transaction Message
        try {
            ReceiptTransactionOut result = apiInstance.calculationsserviceReceiptPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsserviceReceiptPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
ReceiptTransactionIn *body = ; // Transaction Message

ServiceCalculationsApi *apiInstance = [[ServiceCalculationsApi alloc] init];

// Calculation Method
[apiInstance calculationsserviceReceiptPostWith:authorization
    body:body
              completionHandler: ^(ReceiptTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {ReceiptTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculationsserviceReceiptPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsserviceReceiptPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new ReceiptTransactionIn(); // ReceiptTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                ReceiptTransactionOut result = apiInstance.calculationsserviceReceiptPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceCalculationsApi.calculationsserviceReceiptPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // ReceiptTransactionIn | Transaction Message

try {
    $result = $api_instance->calculationsserviceReceiptPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceCalculationsApi->calculationsserviceReceiptPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


calculationsserviceSalesPost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned. Accept all transactions type (Sale, Purchase, Payment and Receipt), the format and message type are desbribed above in each 'calculations-<type>'.


/calculations?service-sales

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/calculations?service-sales"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceCalculationsApi;

import java.io.File;
import java.util.*;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        SalesTransactionIn body = ; // SalesTransactionIn | Transaction Message
        try {
            SalesTransactionOut result = apiInstance.calculationsserviceSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsserviceSalesPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceCalculationsApi;

public class ServiceCalculationsApiExample {

    public static void main(String[] args) {
        ServiceCalculationsApi apiInstance = new ServiceCalculationsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        SalesTransactionIn body = ; // SalesTransactionIn | Transaction Message
        try {
            SalesTransactionOut result = apiInstance.calculationsserviceSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCalculationsApi#calculationsserviceSalesPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
SalesTransactionIn *body = ; // Transaction Message

ServiceCalculationsApi *apiInstance = [[ServiceCalculationsApi alloc] init];

// Calculation Method
[apiInstance calculationsserviceSalesPostWith:authorization
    body:body
              completionHandler: ^(SalesTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceCalculationsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {SalesTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculationsserviceSalesPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculationsserviceSalesPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceCalculationsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new SalesTransactionIn(); // SalesTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                SalesTransactionOut result = apiInstance.calculationsserviceSalesPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceCalculationsApi.calculationsserviceSalesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceCalculationsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // SalesTransactionIn | Transaction Message

try {
    $result = $api_instance->calculationsserviceSalesPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceCalculationsApi->calculationsserviceSalesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


ServiceTransactions

transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet

Retrieve transactions

Retrieve a single transaction


/transactions/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceTransactionsApi;

import java.io.File;
import java.util.*;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        try {
            apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceTransactionsApi;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        try {
            apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
UUID *accountId = accountId_example; // Account ID
String *companyCode = companyCode_example; // Company Code
String *transactionType = transactionType_example; // Transaction Type (sale, purchase, receipts or payment)
String *documentCode = documentCode_example; // Document Code

ServiceTransactionsApi *apiInstance = [[ServiceTransactionsApi alloc] init];

// Retrieve transactions
[apiInstance transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGetWith:authorization
    accountId:accountId
    companyCode:companyCode
    transactionType:transactionType
    documentCode:documentCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var accountId = accountId_example; // {UUID} Account ID

var companyCode = companyCode_example; // {String} Company Code

var transactionType = transactionType_example; // {String} Transaction Type (sale, purchase, receipts or payment)

var documentCode = documentCode_example; // {String} Document Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGetExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var accountId = accountId_example;  // UUID | Account ID
            var companyCode = companyCode_example;  // String | Company Code
            var transactionType = transactionType_example;  // String | Transaction Type (sale, purchase, receipts or payment)
            var documentCode = documentCode_example;  // String | Document Code

            try
            {
                // Retrieve transactions
                apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet(authorization, accountId, companyCode, transactionType, documentCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceTransactionsApi.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$accountId = accountId_example; // UUID | Account ID
$companyCode = companyCode_example; // String | Company Code
$transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
$documentCode = documentCode_example; // String | Document Code

try {
    $api_instance->transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet($authorization, $accountId, $companyCode, $transactionType, $documentCode);
} catch (Exception $e) {
    echo 'Exception when calling ServiceTransactionsApi->transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
companyCode*
transactionType*
documentCode*
Header parameters
Name Description
authorization*

Responses

Status: 200 - List of transaction

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost

Transaction State Transition

Transaction State Transition Voided Send this event to a Recorded tax transaction record to mark it as voided. Recorded -> Voided UnVoided Send this event to a Voided tax transaction record to mark it as recorded. Voided -> Recorded Reconciled Send this event to a Recorded tax transaction record to indicate that it has been reconciled with client systems and to prevent it from being edited prior to filing. This is useful when a transaction will be filed and you do not want it to change again to facilitate auditing and reconciliation. Recorded -> Reconciled UnReconciled Send this event to a Reconciled tax transaction record to indicate that it has not been reconciled and may need to be edited. This is useful when a Tax transaction was erroniously put into the reconciled state. Reconciled -> Recorded Filed Send this event to a Reconciled transaction to indicate that it has been part of a tax filing by the client system. Reconciled -> Filed UnFiled Send this event to a Filed transaction to indicate that it has NOT been part of a tax filing by the client system. Filed -> Reconciled FiledByAvalara This event can only be sent by Avalara Systems. Reconciled -> FiledByAvalara


/transactions/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}/stateTransitions

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions/account/{accountId}/company/{companyCode}/{transactionType}/{documentCode}/stateTransitions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceTransactionsApi;

import java.io.File;
import java.util.*;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        StateTransition body = ; // StateTransition | Transaction Message
        try {
            apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost(authorization, accountId, companyCode, transactionType, documentCode, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceTransactionsApi;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        String documentCode = documentCode_example; // String | Document Code
        StateTransition body = ; // StateTransition | Transaction Message
        try {
            apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost(authorization, accountId, companyCode, transactionType, documentCode, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
UUID *accountId = accountId_example; // Account ID
String *companyCode = companyCode_example; // Company Code
String *transactionType = transactionType_example; // Transaction Type (sale, purchase, receipts or payment)
String *documentCode = documentCode_example; // Document Code
StateTransition *body = ; // Transaction Message

ServiceTransactionsApi *apiInstance = [[ServiceTransactionsApi alloc] init];

// Transaction State Transition
[apiInstance transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPostWith:authorization
    accountId:accountId
    companyCode:companyCode
    transactionType:transactionType
    documentCode:documentCode
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var accountId = accountId_example; // {UUID} Account ID

var companyCode = companyCode_example; // {String} Company Code

var transactionType = transactionType_example; // {String} Transaction Type (sale, purchase, receipts or payment)

var documentCode = documentCode_example; // {String} Document Code

var body = ; // {StateTransition} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost(authorization, accountId, companyCode, transactionType, documentCode, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var accountId = accountId_example;  // UUID | Account ID
            var companyCode = companyCode_example;  // String | Company Code
            var transactionType = transactionType_example;  // String | Transaction Type (sale, purchase, receipts or payment)
            var documentCode = documentCode_example;  // String | Document Code
            var body = new StateTransition(); // StateTransition | Transaction Message

            try
            {
                // Transaction State Transition
                apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost(authorization, accountId, companyCode, transactionType, documentCode, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceTransactionsApi.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$accountId = accountId_example; // UUID | Account ID
$companyCode = companyCode_example; // String | Company Code
$transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
$documentCode = documentCode_example; // String | Document Code
$body = ; // StateTransition | Transaction Message

try {
    $api_instance->transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost($authorization, $accountId, $companyCode, $transactionType, $documentCode, $body);
} catch (Exception $e) {
    echo 'Exception when calling ServiceTransactionsApi->transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeDocumentCodeStateTransitionsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
companyCode*
transactionType*
documentCode*
Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet

Retrieve transactions

Retrieve a list of transactions


/transactions/account/{accountId}/company/{companyCode}/{transactionType}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions/account/{accountId}/company/{companyCode}/{transactionType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceTransactionsApi;

import java.io.File;
import java.util.*;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        try {
            apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceTransactionsApi;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        UUID accountId = accountId_example; // UUID | Account ID
        String companyCode = companyCode_example; // String | Company Code
        String transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)
        try {
            apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
UUID *accountId = accountId_example; // Account ID
String *companyCode = companyCode_example; // Company Code
String *transactionType = transactionType_example; // Transaction Type (sale, purchase, receipts or payment)

ServiceTransactionsApi *apiInstance = [[ServiceTransactionsApi alloc] init];

// Retrieve transactions
[apiInstance transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGetWith:authorization
    accountId:accountId
    companyCode:companyCode
    transactionType:transactionType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var accountId = accountId_example; // {UUID} Account ID

var companyCode = companyCode_example; // {String} Company Code

var transactionType = transactionType_example; // {String} Transaction Type (sale, purchase, receipts or payment)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGetExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var accountId = accountId_example;  // UUID | Account ID
            var companyCode = companyCode_example;  // String | Company Code
            var transactionType = transactionType_example;  // String | Transaction Type (sale, purchase, receipts or payment)

            try
            {
                // Retrieve transactions
                apiInstance.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet(authorization, accountId, companyCode, transactionType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceTransactionsApi.transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$accountId = accountId_example; // UUID | Account ID
$companyCode = companyCode_example; // String | Company Code
$transactionType = transactionType_example; // String | Transaction Type (sale, purchase, receipts or payment)

try {
    $api_instance->transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet($authorization, $accountId, $companyCode, $transactionType);
} catch (Exception $e) {
    echo 'Exception when calling ServiceTransactionsApi->transactionsAccountAccountIdCompanyCompanyCodeTransactionTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
accountId*
companyCode*
transactionType*
Header parameters
Name Description
authorization*

Responses

Status: 200 - List of transaction

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


transactionsservicePaymentPost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned.


/transactions?service-payment

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions?service-payment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceTransactionsApi;

import java.io.File;
import java.util.*;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PaymentTransactionIn body = ; // PaymentTransactionIn | Transaction Message
        try {
            PaymentTransactionOut result = apiInstance.transactionsservicePaymentPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsservicePaymentPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceTransactionsApi;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PaymentTransactionIn body = ; // PaymentTransactionIn | Transaction Message
        try {
            PaymentTransactionOut result = apiInstance.transactionsservicePaymentPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsservicePaymentPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
PaymentTransactionIn *body = ; // Transaction Message

ServiceTransactionsApi *apiInstance = [[ServiceTransactionsApi alloc] init];

// Calculation Method
[apiInstance transactionsservicePaymentPostWith:authorization
    body:body
              completionHandler: ^(PaymentTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {PaymentTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transactionsservicePaymentPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsservicePaymentPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new PaymentTransactionIn(); // PaymentTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                PaymentTransactionOut result = apiInstance.transactionsservicePaymentPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceTransactionsApi.transactionsservicePaymentPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // PaymentTransactionIn | Transaction Message

try {
    $result = $api_instance->transactionsservicePaymentPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceTransactionsApi->transactionsservicePaymentPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


transactionsservicePurchasePost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned.


/transactions?service-purchase

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions?service-purchase"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceTransactionsApi;

import java.io.File;
import java.util.*;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PurchaseTransactionIn body = ; // PurchaseTransactionIn | Transaction Message
        try {
            PurchaseTransactionOut result = apiInstance.transactionsservicePurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsservicePurchasePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceTransactionsApi;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        PurchaseTransactionIn body = ; // PurchaseTransactionIn | Transaction Message
        try {
            PurchaseTransactionOut result = apiInstance.transactionsservicePurchasePost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsservicePurchasePost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
PurchaseTransactionIn *body = ; // Transaction Message

ServiceTransactionsApi *apiInstance = [[ServiceTransactionsApi alloc] init];

// Calculation Method
[apiInstance transactionsservicePurchasePostWith:authorization
    body:body
              completionHandler: ^(PurchaseTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {PurchaseTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transactionsservicePurchasePost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsservicePurchasePostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new PurchaseTransactionIn(); // PurchaseTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                PurchaseTransactionOut result = apiInstance.transactionsservicePurchasePost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceTransactionsApi.transactionsservicePurchasePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // PurchaseTransactionIn | Transaction Message

try {
    $result = $api_instance->transactionsservicePurchasePost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceTransactionsApi->transactionsservicePurchasePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


transactionsserviceReceiptPost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned.


/transactions?service-receipt

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions?service-receipt"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceTransactionsApi;

import java.io.File;
import java.util.*;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        ReceiptTransactionIn body = ; // ReceiptTransactionIn | Transaction Message
        try {
            ReceiptTransactionOut result = apiInstance.transactionsserviceReceiptPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsserviceReceiptPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceTransactionsApi;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        ReceiptTransactionIn body = ; // ReceiptTransactionIn | Transaction Message
        try {
            ReceiptTransactionOut result = apiInstance.transactionsserviceReceiptPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsserviceReceiptPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
ReceiptTransactionIn *body = ; // Transaction Message

ServiceTransactionsApi *apiInstance = [[ServiceTransactionsApi alloc] init];

// Calculation Method
[apiInstance transactionsserviceReceiptPostWith:authorization
    body:body
              completionHandler: ^(ReceiptTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {ReceiptTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transactionsserviceReceiptPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsserviceReceiptPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new ReceiptTransactionIn(); // ReceiptTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                ReceiptTransactionOut result = apiInstance.transactionsserviceReceiptPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceTransactionsApi.transactionsserviceReceiptPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // ReceiptTransactionIn | Transaction Message

try {
    $result = $api_instance->transactionsserviceReceiptPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceTransactionsApi->transactionsserviceReceiptPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


transactionsserviceSalesPost

Calculation Method

Refer to the business rules below, for an outline view of Tax Determination Process as a whole, showing a beginning-to-end process making use of the specific UseCases and discriminating all required attributes and data to be returned.


/transactions?service-sales

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/transactions?service-sales"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceTransactionsApi;

import java.io.File;
import java.util.*;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        SalesTransactionIn body = ; // SalesTransactionIn | Transaction Message
        try {
            SalesTransactionOut result = apiInstance.transactionsserviceSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsserviceSalesPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceTransactionsApi;

public class ServiceTransactionsApiExample {

    public static void main(String[] args) {
        ServiceTransactionsApi apiInstance = new ServiceTransactionsApi();
        String authorization = authorization_example; // String | Bearer {auth}
        SalesTransactionIn body = ; // SalesTransactionIn | Transaction Message
        try {
            SalesTransactionOut result = apiInstance.transactionsserviceSalesPost(authorization, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceTransactionsApi#transactionsserviceSalesPost");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer {auth}
SalesTransactionIn *body = ; // Transaction Message

ServiceTransactionsApi *apiInstance = [[ServiceTransactionsApi alloc] init];

// Calculation Method
[apiInstance transactionsserviceSalesPostWith:authorization
    body:body
              completionHandler: ^(SalesTransactionOut output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.ServiceTransactionsApi()

var authorization = authorization_example; // {String} Bearer {auth}

var body = ; // {SalesTransactionIn} Transaction Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transactionsserviceSalesPost(authorization, body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transactionsserviceSalesPostExample
    {
        public void main()
        {
            
            var apiInstance = new ServiceTransactionsApi();
            var authorization = authorization_example;  // String | Bearer {auth}
            var body = new SalesTransactionIn(); // SalesTransactionIn | Transaction Message

            try
            {
                // Calculation Method
                SalesTransactionOut result = apiInstance.transactionsserviceSalesPost(authorization, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceTransactionsApi.transactionsserviceSalesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServiceTransactionsApi();
$authorization = authorization_example; // String | Bearer {auth}
$body = ; // SalesTransactionIn | Transaction Message

try {
    $result = $api_instance->transactionsserviceSalesPost($authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceTransactionsApi->transactionsserviceSalesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Header parameters
Name Description
authorization*
Body parameters
Name Description
body *

Responses

Status: 200 - Transaction Out

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


TaxConfCFOP

createCfop

create a new CFOP configuration


/taxconf/cfop

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/cfop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfCFOPApi;

import java.io.File;
import java.util.*;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        CfopConf body = ; // CfopConf | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createCfop(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#createCfop");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfCFOPApi;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        CfopConf body = ; // CfopConf | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createCfop(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#createCfop");
            e.printStackTrace();
        }
    }
}
CfopConf *body = ; // The pet JSON you want to post

TaxConfCFOPApi *apiInstance = [[TaxConfCFOPApi alloc] init];

// create a new CFOP configuration
[apiInstance createCfopWith:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfCFOPApi()

var body = ; // {CfopConf} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCfop(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCfopExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfCFOPApi();
            var body = new CfopConf(); // CfopConf | The pet JSON you want to post

            try
            {
                // create a new CFOP configuration
                inline_response_201 result = apiInstance.createCfop(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfCFOPApi.createCfop: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfCFOPApi();
$body = ; // CfopConf | The pet JSON you want to post

try {
    $result = $api_instance->createCfop($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfCFOPApi->createCfop: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteCfop

disable a CFOP.


/taxconf/cfop/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/cfop/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfCFOPApi;

import java.io.File;
import java.util.*;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String code = code_example; // String | CFOP Code
        try {
            apiInstance.deleteCfop(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#deleteCfop");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfCFOPApi;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String code = code_example; // String | CFOP Code
        try {
            apiInstance.deleteCfop(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#deleteCfop");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // CFOP Code

TaxConfCFOPApi *apiInstance = [[TaxConfCFOPApi alloc] init];

// disable a CFOP.
[apiInstance deleteCfopWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfCFOPApi()

var code = code_example; // {String} CFOP Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCfop(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCfopExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfCFOPApi();
            var code = code_example;  // String | CFOP Code

            try
            {
                // disable a CFOP.
                apiInstance.deleteCfop(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfCFOPApi.deleteCfop: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfCFOPApi();
$code = code_example; // String | CFOP Code

try {
    $api_instance->deleteCfop($code);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfCFOPApi->deleteCfop: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getCfop

get CFOP information.

This operation return CFOP configuration


/taxconf/cfop/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/cfop/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfCFOPApi;

import java.io.File;
import java.util.*;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String code = code_example; // String | CFOP Code
        try {
            CfopConf result = apiInstance.getCfop(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#getCfop");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfCFOPApi;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String code = code_example; // String | CFOP Code
        try {
            CfopConf result = apiInstance.getCfop(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#getCfop");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // CFOP Code

TaxConfCFOPApi *apiInstance = [[TaxConfCFOPApi alloc] init];

// get CFOP information.
[apiInstance getCfopWith:code
              completionHandler: ^(CfopConf output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfCFOPApi()

var code = code_example; // {String} CFOP Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCfop(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCfopExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfCFOPApi();
            var code = code_example;  // String | CFOP Code

            try
            {
                // get CFOP information.
                CfopConf result = apiInstance.getCfop(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfCFOPApi.getCfop: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfCFOPApi();
$code = code_example; // String | CFOP Code

try {
    $result = $api_instance->getCfop($code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfCFOPApi->getCfop: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getCfopList

retrive list of CFOP.

This operation return CFOP configurations that match with parameters queries


/taxconf/cfop

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/cfop?suffixcode=&date=&inactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfCFOPApi;

import java.io.File;
import java.util.*;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String suffixcode = suffixcode_example; // String | Identify this CFOP, the CFOP Code has two parts N.XXX where N the prefix is the operation scope type if IN or OUT and if is in state, other state, other country and suffix XXX is the operation type

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[CfopConf] result = apiInstance.getCfopList(suffixcode, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#getCfopList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfCFOPApi;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String suffixcode = suffixcode_example; // String | Identify this CFOP, the CFOP Code has two parts N.XXX where N the prefix is the operation scope type if IN or OUT and if is in state, other state, other country and suffix XXX is the operation type

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[CfopConf] result = apiInstance.getCfopList(suffixcode, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#getCfopList");
            e.printStackTrace();
        }
    }
}
String *suffixcode = suffixcode_example; // Identify this CFOP, the CFOP Code has two parts N.XXX where N the prefix is the operation scope type if IN or OUT and if is in state, other state, other country and suffix XXX is the operation type
 (optional)
date *date = 2013-10-20; // When informed return valid version configuration for this date
 (optional)
Boolean *inactive = true; // return the inactive versions too
 (optional)

TaxConfCFOPApi *apiInstance = [[TaxConfCFOPApi alloc] init];

// retrive list of CFOP.
[apiInstance getCfopListWith:suffixcode
    date:date
    inactive:inactive
              completionHandler: ^(array[CfopConf] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfCFOPApi()

var opts = { 
  'suffixcode': suffixcode_example, // {String} Identify this CFOP, the CFOP Code has two parts N.XXX where N the prefix is the operation scope type if IN or OUT and if is in state, other state, other country and suffix XXX is the operation type

  'date': 2013-10-20, // {date} When informed return valid version configuration for this date

  'inactive': true // {Boolean} return the inactive versions too

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCfopList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCfopListExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfCFOPApi();
            var suffixcode = suffixcode_example;  // String | Identify this CFOP, the CFOP Code has two parts N.XXX where N the prefix is the operation scope type if IN or OUT and if is in state, other state, other country and suffix XXX is the operation type
 (optional) 
            var date = 2013-10-20;  // date | When informed return valid version configuration for this date
 (optional) 
            var inactive = true;  // Boolean | return the inactive versions too
 (optional) 

            try
            {
                // retrive list of CFOP.
                array[CfopConf] result = apiInstance.getCfopList(suffixcode, date, inactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfCFOPApi.getCfopList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfCFOPApi();
$suffixcode = suffixcode_example; // String | Identify this CFOP, the CFOP Code has two parts N.XXX where N the prefix is the operation scope type if IN or OUT and if is in state, other state, other country and suffix XXX is the operation type

$date = 2013-10-20; // date | When informed return valid version configuration for this date

$inactive = true; // Boolean | return the inactive versions too


try {
    $result = $api_instance->getCfopList($suffixcode, $date, $inactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfCFOPApi->getCfopList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
suffixcode
date
inactive

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateCfop

update a CFOP configuration


/taxconf/cfop/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/cfop/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfCFOPApi;

import java.io.File;
import java.util.*;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String code = code_example; // String | CFOP Code
        CfopConf taxconfcfop = ; // CfopConf | The pet JSON you want to post
        try {
            apiInstance.updateCfop(code, taxconfcfop);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#updateCfop");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfCFOPApi;

public class TaxConfCFOPApiExample {

    public static void main(String[] args) {
        TaxConfCFOPApi apiInstance = new TaxConfCFOPApi();
        String code = code_example; // String | CFOP Code
        CfopConf taxconfcfop = ; // CfopConf | The pet JSON you want to post
        try {
            apiInstance.updateCfop(code, taxconfcfop);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfCFOPApi#updateCfop");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // CFOP Code
CfopConf *taxconfcfop = ; // The pet JSON you want to post

TaxConfCFOPApi *apiInstance = [[TaxConfCFOPApi alloc] init];

// update a CFOP configuration
[apiInstance updateCfopWith:code
    taxconfcfop:taxconfcfop
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfCFOPApi()

var code = code_example; // {String} CFOP Code

var taxconfcfop = ; // {CfopConf} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCfop(codetaxconfcfop, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCfopExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfCFOPApi();
            var code = code_example;  // String | CFOP Code
            var taxconfcfop = new CfopConf(); // CfopConf | The pet JSON you want to post

            try
            {
                // update a CFOP configuration
                apiInstance.updateCfop(code, taxconfcfop);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfCFOPApi.updateCfop: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfCFOPApi();
$code = code_example; // String | CFOP Code
$taxconfcfop = ; // CfopConf | The pet JSON you want to post

try {
    $api_instance->updateCfop($code, $taxconfcfop);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfCFOPApi->updateCfop: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*
Body parameters
Name Description
taxconfcfop *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


TaxConfIBPT

createIbptConf

create a new Process Type configuration


/taxconf/ibpt

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/ibpt"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfIBPTApi;

import java.io.File;
import java.util.*;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        IbptConf taxconfprocess = ; // IbptConf | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createIbptConf(taxconfprocess);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#createIbptConf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfIBPTApi;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        IbptConf taxconfprocess = ; // IbptConf | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createIbptConf(taxconfprocess);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#createIbptConf");
            e.printStackTrace();
        }
    }
}
IbptConf *taxconfprocess = ; // The pet JSON you want to post

TaxConfIBPTApi *apiInstance = [[TaxConfIBPTApi alloc] init];

// create a new Process Type configuration
[apiInstance createIbptConfWith:taxconfprocess
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfIBPTApi()

var taxconfprocess = ; // {IbptConf} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createIbptConf(taxconfprocess, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createIbptConfExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfIBPTApi();
            var taxconfprocess = new IbptConf(); // IbptConf | The pet JSON you want to post

            try
            {
                // create a new Process Type configuration
                inline_response_201 result = apiInstance.createIbptConf(taxconfprocess);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfIBPTApi.createIbptConf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfIBPTApi();
$taxconfprocess = ; // IbptConf | The pet JSON you want to post

try {
    $result = $api_instance->createIbptConf($taxconfprocess);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfIBPTApi->createIbptConf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
taxconfprocess *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteIbptConf

disable a IBPT.


/taxconf/ibpt/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/ibpt/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfIBPTApi;

import java.io.File;
import java.util.*;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String code = code_example; // String | IBPT Code
        try {
            apiInstance.deleteIbptConf(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#deleteIbptConf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfIBPTApi;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String code = code_example; // String | IBPT Code
        try {
            apiInstance.deleteIbptConf(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#deleteIbptConf");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // IBPT Code

TaxConfIBPTApi *apiInstance = [[TaxConfIBPTApi alloc] init];

// disable a IBPT.
[apiInstance deleteIbptConfWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfIBPTApi()

var code = code_example; // {String} IBPT Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteIbptConf(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteIbptConfExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfIBPTApi();
            var code = code_example;  // String | IBPT Code

            try
            {
                // disable a IBPT.
                apiInstance.deleteIbptConf(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfIBPTApi.deleteIbptConf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfIBPTApi();
$code = code_example; // String | IBPT Code

try {
    $api_instance->deleteIbptConf($code);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfIBPTApi->deleteIbptConf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getIbptConf

get IBPT information.

This operation return Process Type configuration


/taxconf/ibpt/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/ibpt/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfIBPTApi;

import java.io.File;
import java.util.*;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String code = code_example; // String | IBPT Code
        try {
            IbptConf result = apiInstance.getIbptConf(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#getIbptConf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfIBPTApi;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String code = code_example; // String | IBPT Code
        try {
            IbptConf result = apiInstance.getIbptConf(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#getIbptConf");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // IBPT Code

TaxConfIBPTApi *apiInstance = [[TaxConfIBPTApi alloc] init];

// get IBPT information.
[apiInstance getIbptConfWith:code
              completionHandler: ^(IbptConf output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfIBPTApi()

var code = code_example; // {String} IBPT Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIbptConf(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIbptConfExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfIBPTApi();
            var code = code_example;  // String | IBPT Code

            try
            {
                // get IBPT information.
                IbptConf result = apiInstance.getIbptConf(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfIBPTApi.getIbptConf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfIBPTApi();
$code = code_example; // String | IBPT Code

try {
    $result = $api_instance->getIbptConf($code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfIBPTApi->getIbptConf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getIbptConfList

retrive list of IBPT.

This operation return Process Type configurations that match with parameters queries


/taxconf/ibpt

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/ibpt?accountId=&date=&inactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfIBPTApi;

import java.io.File;
import java.util.*;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String accountId = accountId_example; // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[IbptConf] result = apiInstance.getIbptConfList(accountId, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#getIbptConfList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfIBPTApi;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String accountId = accountId_example; // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[IbptConf] result = apiInstance.getIbptConfList(accountId, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#getIbptConfList");
            e.printStackTrace();
        }
    }
}
String *accountId = accountId_example; // filter the configuration by accountID, if not informed, only the standard configuration will be returned
 (optional)
date *date = 2013-10-20; // When informed return valid version configuration for this date
 (optional)
Boolean *inactive = true; // return the inactive versions too
 (optional)

TaxConfIBPTApi *apiInstance = [[TaxConfIBPTApi alloc] init];

// retrive list of IBPT.
[apiInstance getIbptConfListWith:accountId
    date:date
    inactive:inactive
              completionHandler: ^(array[IbptConf] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfIBPTApi()

var opts = { 
  'accountId': accountId_example, // {String} filter the configuration by accountID, if not informed, only the standard configuration will be returned

  'date': 2013-10-20, // {date} When informed return valid version configuration for this date

  'inactive': true // {Boolean} return the inactive versions too

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIbptConfList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIbptConfListExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfIBPTApi();
            var accountId = accountId_example;  // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned
 (optional) 
            var date = 2013-10-20;  // date | When informed return valid version configuration for this date
 (optional) 
            var inactive = true;  // Boolean | return the inactive versions too
 (optional) 

            try
            {
                // retrive list of IBPT.
                array[IbptConf] result = apiInstance.getIbptConfList(accountId, date, inactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfIBPTApi.getIbptConfList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfIBPTApi();
$accountId = accountId_example; // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned

$date = 2013-10-20; // date | When informed return valid version configuration for this date

$inactive = true; // Boolean | return the inactive versions too


try {
    $result = $api_instance->getIbptConfList($accountId, $date, $inactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfIBPTApi->getIbptConfList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
accountId
date
inactive

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateIbptConf

update a Process Type configuration


/taxconf/ibpt/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/ibpt/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfIBPTApi;

import java.io.File;
import java.util.*;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String code = code_example; // String | IBPT Code
        IbptConf taxconfprocess = ; // IbptConf | The pet JSON you want to post
        try {
            apiInstance.updateIbptConf(code, taxconfprocess);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#updateIbptConf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfIBPTApi;

public class TaxConfIBPTApiExample {

    public static void main(String[] args) {
        TaxConfIBPTApi apiInstance = new TaxConfIBPTApi();
        String code = code_example; // String | IBPT Code
        IbptConf taxconfprocess = ; // IbptConf | The pet JSON you want to post
        try {
            apiInstance.updateIbptConf(code, taxconfprocess);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfIBPTApi#updateIbptConf");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // IBPT Code
IbptConf *taxconfprocess = ; // The pet JSON you want to post

TaxConfIBPTApi *apiInstance = [[TaxConfIBPTApi alloc] init];

// update a Process Type configuration
[apiInstance updateIbptConfWith:code
    taxconfprocess:taxconfprocess
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfIBPTApi()

var code = code_example; // {String} IBPT Code

var taxconfprocess = ; // {IbptConf} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateIbptConf(codetaxconfprocess, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateIbptConfExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfIBPTApi();
            var code = code_example;  // String | IBPT Code
            var taxconfprocess = new IbptConf(); // IbptConf | The pet JSON you want to post

            try
            {
                // update a Process Type configuration
                apiInstance.updateIbptConf(code, taxconfprocess);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfIBPTApi.updateIbptConf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfIBPTApi();
$code = code_example; // String | IBPT Code
$taxconfprocess = ; // IbptConf | The pet JSON you want to post

try {
    $api_instance->updateIbptConf($code, $taxconfprocess);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfIBPTApi->updateIbptConf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*
Body parameters
Name Description
taxconfprocess *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


TaxConfICMS

createIcmsconfstate

create a new ICMS Configuration


/taxconf/icms/{state}

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/icms/{state}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfICMSApi;

import java.io.File;
import java.util.*;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        IcmsConfByState icmsConfState = ; // IcmsConfByState | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createIcmsconfstate(state, icmsConfState);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#createIcmsconfstate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfICMSApi;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        IcmsConfByState icmsConfState = ; // IcmsConfByState | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createIcmsconfstate(state, icmsConfState);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#createIcmsconfstate");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State
IcmsConfByState *icmsConfState = ; // The pet JSON you want to post

TaxConfICMSApi *apiInstance = [[TaxConfICMSApi alloc] init];

// create a new ICMS Configuration
[apiInstance createIcmsconfstateWith:state
    icmsConfState:icmsConfState
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfICMSApi()

var state = state_example; // {String} Brazilian State

var icmsConfState = ; // {IcmsConfByState} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createIcmsconfstate(state, icmsConfState, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createIcmsconfstateExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfICMSApi();
            var state = state_example;  // String | Brazilian State
            var icmsConfState = new IcmsConfByState(); // IcmsConfByState | The pet JSON you want to post

            try
            {
                // create a new ICMS Configuration
                inline_response_201 result = apiInstance.createIcmsconfstate(state, icmsConfState);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfICMSApi.createIcmsconfstate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfICMSApi();
$state = state_example; // String | Brazilian State
$icmsConfState = ; // IcmsConfByState | The pet JSON you want to post

try {
    $result = $api_instance->createIcmsconfstate($state, $icmsConfState);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfICMSApi->createIcmsconfstate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*
Body parameters
Name Description
icmsConfState *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteIcmsConf

disable a ICMS by State.


/taxconf/icms/{state}/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/icms/{state}/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfICMSApi;

import java.io.File;
import java.util.*;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String code = code_example; // String | ICMS Code
        try {
            apiInstance.deleteIcmsConf(state, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#deleteIcmsConf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfICMSApi;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String code = code_example; // String | ICMS Code
        try {
            apiInstance.deleteIcmsConf(state, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#deleteIcmsConf");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State
String *code = code_example; // ICMS Code

TaxConfICMSApi *apiInstance = [[TaxConfICMSApi alloc] init];

// disable a ICMS by State.
[apiInstance deleteIcmsConfWith:state
    code:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfICMSApi()

var state = state_example; // {String} Brazilian State

var code = code_example; // {String} ICMS Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteIcmsConf(state, code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteIcmsConfExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfICMSApi();
            var state = state_example;  // String | Brazilian State
            var code = code_example;  // String | ICMS Code

            try
            {
                // disable a ICMS by State.
                apiInstance.deleteIcmsConf(state, code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfICMSApi.deleteIcmsConf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfICMSApi();
$state = state_example; // String | Brazilian State
$code = code_example; // String | ICMS Code

try {
    $api_instance->deleteIcmsConf($state, $code);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfICMSApi->deleteIcmsConf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getIcmsConfByState

get ICMS information by State.

This operation return configurations of icms that match with parameters queries


/taxconf/icms/{state}/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/icms/{state}/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfICMSApi;

import java.io.File;
import java.util.*;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String code = code_example; // String | ICMS Code
        try {
            array[IcmsConfByState] result = apiInstance.getIcmsConfByState(state, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#getIcmsConfByState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfICMSApi;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String code = code_example; // String | ICMS Code
        try {
            array[IcmsConfByState] result = apiInstance.getIcmsConfByState(state, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#getIcmsConfByState");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State
String *code = code_example; // ICMS Code

TaxConfICMSApi *apiInstance = [[TaxConfICMSApi alloc] init];

// get ICMS information by State.
[apiInstance getIcmsConfByStateWith:state
    code:code
              completionHandler: ^(array[IcmsConfByState] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfICMSApi()

var state = state_example; // {String} Brazilian State

var code = code_example; // {String} ICMS Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIcmsConfByState(state, code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIcmsConfByStateExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfICMSApi();
            var state = state_example;  // String | Brazilian State
            var code = code_example;  // String | ICMS Code

            try
            {
                // get ICMS information by State.
                array[IcmsConfByState] result = apiInstance.getIcmsConfByState(state, code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfICMSApi.getIcmsConfByState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfICMSApi();
$state = state_example; // String | Brazilian State
$code = code_example; // String | ICMS Code

try {
    $result = $api_instance->getIcmsConfByState($state, $code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfICMSApi->getIcmsConfByState: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*
code*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getIcmsList

retrive list of ICMS.

This operation return ICMS configurations that match with parameters queries


/taxconf/icms/{state}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/icms/{state}?suffixcode=&date=&inactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfICMSApi;

import java.io.File;
import java.util.*;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String suffixcode = suffixcode_example; // String | Identify this ICMS
        date date = 2013-10-20; // date | When informed return valid version configuration for this date
        Boolean inactive = true; // Boolean | return the inactive versions too
        try {
            array[IcmsConfByState] result = apiInstance.getIcmsList(state, suffixcode, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#getIcmsList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfICMSApi;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String suffixcode = suffixcode_example; // String | Identify this ICMS
        date date = 2013-10-20; // date | When informed return valid version configuration for this date
        Boolean inactive = true; // Boolean | return the inactive versions too
        try {
            array[IcmsConfByState] result = apiInstance.getIcmsList(state, suffixcode, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#getIcmsList");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State
String *suffixcode = suffixcode_example; // Identify this ICMS (optional)
date *date = 2013-10-20; // When informed return valid version configuration for this date (optional)
Boolean *inactive = true; // return the inactive versions too (optional)

TaxConfICMSApi *apiInstance = [[TaxConfICMSApi alloc] init];

// retrive list of ICMS.
[apiInstance getIcmsListWith:state
    suffixcode:suffixcode
    date:date
    inactive:inactive
              completionHandler: ^(array[IcmsConfByState] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfICMSApi()

var state = state_example; // {String} Brazilian State

var opts = { 
  'suffixcode': suffixcode_example, // {String} Identify this ICMS
  'date': 2013-10-20, // {date} When informed return valid version configuration for this date
  'inactive': true // {Boolean} return the inactive versions too
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIcmsList(state, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIcmsListExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfICMSApi();
            var state = state_example;  // String | Brazilian State
            var suffixcode = suffixcode_example;  // String | Identify this ICMS (optional) 
            var date = 2013-10-20;  // date | When informed return valid version configuration for this date (optional) 
            var inactive = true;  // Boolean | return the inactive versions too (optional) 

            try
            {
                // retrive list of ICMS.
                array[IcmsConfByState] result = apiInstance.getIcmsList(state, suffixcode, date, inactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfICMSApi.getIcmsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfICMSApi();
$state = state_example; // String | Brazilian State
$suffixcode = suffixcode_example; // String | Identify this ICMS
$date = 2013-10-20; // date | When informed return valid version configuration for this date
$inactive = true; // Boolean | return the inactive versions too

try {
    $result = $api_instance->getIcmsList($state, $suffixcode, $date, $inactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfICMSApi->getIcmsList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*
Query parameters
Name Description
suffixcode
date
inactive

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getIcmsList_1

retrive list of ICMS.

This operation return ICMS configurations that match with parameters queries


/taxconf/icms-search/

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/icms-search/?text=&state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfICMSApi;

import java.io.File;
import java.util.*;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String text = text_example; // String | Search for codes
        String state = state_example; // String | Filter for states
        try {
            array[IcmsConfByState] result = apiInstance.getIcmsList_0(text, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#getIcmsList_0");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfICMSApi;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String text = text_example; // String | Search for codes
        String state = state_example; // String | Filter for states
        try {
            array[IcmsConfByState] result = apiInstance.getIcmsList_0(text, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#getIcmsList_0");
            e.printStackTrace();
        }
    }
}
String *text = text_example; // Search for codes
String *state = state_example; // Filter for states (optional)

TaxConfICMSApi *apiInstance = [[TaxConfICMSApi alloc] init];

// retrive list of ICMS.
[apiInstance getIcmsList_1With:text
    state:state
              completionHandler: ^(array[IcmsConfByState] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfICMSApi()

var text = text_example; // {String} Search for codes

var opts = { 
  'state': state_example // {String} Filter for states
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIcmsList_0(text, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIcmsList_0Example
    {
        public void main()
        {
            
            var apiInstance = new TaxConfICMSApi();
            var text = text_example;  // String | Search for codes
            var state = state_example;  // String | Filter for states (optional) 

            try
            {
                // retrive list of ICMS.
                array[IcmsConfByState] result = apiInstance.getIcmsList_0(text, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfICMSApi.getIcmsList_0: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfICMSApi();
$text = text_example; // String | Search for codes
$state = state_example; // String | Filter for states

try {
    $result = $api_instance->getIcmsList_0($text, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfICMSApi->getIcmsList_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
text*
state

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateIcmsconfstate

update a IcmsConf State,


/taxconf/icms/{state}/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/icms/{state}/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfICMSApi;

import java.io.File;
import java.util.*;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String code = code_example; // String | ICMS Code
        IcmsConfByState icmsConfState = ; // IcmsConfByState | The pet JSON you want to post
        try {
            apiInstance.updateIcmsconfstate(state, code, icmsConfState);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#updateIcmsconfstate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfICMSApi;

public class TaxConfICMSApiExample {

    public static void main(String[] args) {
        TaxConfICMSApi apiInstance = new TaxConfICMSApi();
        String state = state_example; // String | Brazilian State
        String code = code_example; // String | ICMS Code
        IcmsConfByState icmsConfState = ; // IcmsConfByState | The pet JSON you want to post
        try {
            apiInstance.updateIcmsconfstate(state, code, icmsConfState);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfICMSApi#updateIcmsconfstate");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Brazilian State
String *code = code_example; // ICMS Code
IcmsConfByState *icmsConfState = ; // The pet JSON you want to post

TaxConfICMSApi *apiInstance = [[TaxConfICMSApi alloc] init];

// update a IcmsConf State,
[apiInstance updateIcmsconfstateWith:state
    code:code
    icmsConfState:icmsConfState
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfICMSApi()

var state = state_example; // {String} Brazilian State

var code = code_example; // {String} ICMS Code

var icmsConfState = ; // {IcmsConfByState} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateIcmsconfstate(state, codeicmsConfState, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateIcmsconfstateExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfICMSApi();
            var state = state_example;  // String | Brazilian State
            var code = code_example;  // String | ICMS Code
            var icmsConfState = new IcmsConfByState(); // IcmsConfByState | The pet JSON you want to post

            try
            {
                // update a IcmsConf State,
                apiInstance.updateIcmsconfstate(state, code, icmsConfState);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfICMSApi.updateIcmsconfstate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfICMSApi();
$state = state_example; // String | Brazilian State
$code = code_example; // String | ICMS Code
$icmsConfState = ; // IcmsConfByState | The pet JSON you want to post

try {
    $api_instance->updateIcmsconfstate($state, $code, $icmsConfState);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfICMSApi->updateIcmsconfstate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
state*
code*
Body parameters
Name Description
icmsConfState *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


TaxConfISS

createIssConfByCity

create a new ISS Configuration


/taxconf/iss

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/iss"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfISSApi;

import java.io.File;
import java.util.*;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        IssConfByCity issConfByCity = ; // IssConfByCity | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createIssConfByCity(issConfByCity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#createIssConfByCity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfISSApi;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        IssConfByCity issConfByCity = ; // IssConfByCity | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createIssConfByCity(issConfByCity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#createIssConfByCity");
            e.printStackTrace();
        }
    }
}
IssConfByCity *issConfByCity = ; // The pet JSON you want to post

TaxConfISSApi *apiInstance = [[TaxConfISSApi alloc] init];

// create a new ISS Configuration
[apiInstance createIssConfByCityWith:issConfByCity
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfISSApi()

var issConfByCity = ; // {IssConfByCity} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createIssConfByCity(issConfByCity, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createIssConfByCityExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfISSApi();
            var issConfByCity = new IssConfByCity(); // IssConfByCity | The pet JSON you want to post

            try
            {
                // create a new ISS Configuration
                inline_response_201 result = apiInstance.createIssConfByCity(issConfByCity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfISSApi.createIssConfByCity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfISSApi();
$issConfByCity = ; // IssConfByCity | The pet JSON you want to post

try {
    $result = $api_instance->createIssConfByCity($issConfByCity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfISSApi->createIssConfByCity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
issConfByCity *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteIssConf

disable a ISS by City Code.


/taxconf/iss/{cityCode}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/iss/{cityCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfISSApi;

import java.io.File;
import java.util.*;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        try {
            apiInstance.deleteIssConf(cityCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#deleteIssConf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfISSApi;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        try {
            apiInstance.deleteIssConf(cityCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#deleteIssConf");
            e.printStackTrace();
        }
    }
}
BigDecimal *cityCode = 3.4; // City Code

TaxConfISSApi *apiInstance = [[TaxConfISSApi alloc] init];

// disable a ISS by City Code.
[apiInstance deleteIssConfWith:cityCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfISSApi()

var cityCode = 3.4; // {BigDecimal} City Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteIssConf(cityCode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteIssConfExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfISSApi();
            var cityCode = 3.4;  // BigDecimal | City Code

            try
            {
                // disable a ISS by City Code.
                apiInstance.deleteIssConf(cityCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfISSApi.deleteIssConf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfISSApi();
$cityCode = 3.4; // BigDecimal | City Code

try {
    $api_instance->deleteIssConf($cityCode);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfISSApi->deleteIssConf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
cityCode*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getIssConfByCity

get ISS information by City Code.

This operation return configurations of ISS that match with parameters queries


/taxconf/iss/{cityCode}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/iss/{cityCode}?code=&date=&inactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfISSApi;

import java.io.File;
import java.util.*;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        String code = code_example; // String | Identificator of this configuration, it is unique for account or standard namedspace

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inctives versions too

        try {
            array[IssConfByCity] result = apiInstance.getIssConfByCity(cityCode, code, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#getIssConfByCity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfISSApi;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        String code = code_example; // String | Identificator of this configuration, it is unique for account or standard namedspace

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inctives versions too

        try {
            array[IssConfByCity] result = apiInstance.getIssConfByCity(cityCode, code, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#getIssConfByCity");
            e.printStackTrace();
        }
    }
}
BigDecimal *cityCode = 3.4; // City Code
String *code = code_example; // Identificator of this configuration, it is unique for account or standard namedspace
 (optional)
date *date = 2013-10-20; // When informed return valid version configuration for this date
 (optional)
Boolean *inactive = true; // return the inctives versions too
 (optional)

TaxConfISSApi *apiInstance = [[TaxConfISSApi alloc] init];

// get ISS information by City Code.
[apiInstance getIssConfByCityWith:cityCode
    code:code
    date:date
    inactive:inactive
              completionHandler: ^(array[IssConfByCity] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfISSApi()

var cityCode = 3.4; // {BigDecimal} City Code

var opts = { 
  'code': code_example, // {String} Identificator of this configuration, it is unique for account or standard namedspace

  'date': 2013-10-20, // {date} When informed return valid version configuration for this date

  'inactive': true // {Boolean} return the inctives versions too

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIssConfByCity(cityCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIssConfByCityExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfISSApi();
            var cityCode = 3.4;  // BigDecimal | City Code
            var code = code_example;  // String | Identificator of this configuration, it is unique for account or standard namedspace
 (optional) 
            var date = 2013-10-20;  // date | When informed return valid version configuration for this date
 (optional) 
            var inactive = true;  // Boolean | return the inctives versions too
 (optional) 

            try
            {
                // get ISS information by City Code.
                array[IssConfByCity] result = apiInstance.getIssConfByCity(cityCode, code, date, inactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfISSApi.getIssConfByCity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfISSApi();
$cityCode = 3.4; // BigDecimal | City Code
$code = code_example; // String | Identificator of this configuration, it is unique for account or standard namedspace

$date = 2013-10-20; // date | When informed return valid version configuration for this date

$inactive = true; // Boolean | return the inctives versions too


try {
    $result = $api_instance->getIssConfByCity($cityCode, $code, $date, $inactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfISSApi->getIssConfByCity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
cityCode*
Query parameters
Name Description
code
date
inactive

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getIssList

retrive list of ISS

This operation return ISS configurations that match with parameters queries


/taxconf/iss

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/iss?suffixcode=&date=&inactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfISSApi;

import java.io.File;
import java.util.*;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        String suffixcode = suffixcode_example; // String | Identify this ISS

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[IssConfByCity] result = apiInstance.getIssList(suffixcode, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#getIssList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfISSApi;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        String suffixcode = suffixcode_example; // String | Identify this ISS

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[IssConfByCity] result = apiInstance.getIssList(suffixcode, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#getIssList");
            e.printStackTrace();
        }
    }
}
String *suffixcode = suffixcode_example; // Identify this ISS
 (optional)
date *date = 2013-10-20; // When informed return valid version configuration for this date
 (optional)
Boolean *inactive = true; // return the inactive versions too
 (optional)

TaxConfISSApi *apiInstance = [[TaxConfISSApi alloc] init];

// retrive list of ISS
[apiInstance getIssListWith:suffixcode
    date:date
    inactive:inactive
              completionHandler: ^(array[IssConfByCity] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfISSApi()

var opts = { 
  'suffixcode': suffixcode_example, // {String} Identify this ISS

  'date': 2013-10-20, // {date} When informed return valid version configuration for this date

  'inactive': true // {Boolean} return the inactive versions too

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getIssList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIssListExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfISSApi();
            var suffixcode = suffixcode_example;  // String | Identify this ISS
 (optional) 
            var date = 2013-10-20;  // date | When informed return valid version configuration for this date
 (optional) 
            var inactive = true;  // Boolean | return the inactive versions too
 (optional) 

            try
            {
                // retrive list of ISS
                array[IssConfByCity] result = apiInstance.getIssList(suffixcode, date, inactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfISSApi.getIssList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfISSApi();
$suffixcode = suffixcode_example; // String | Identify this ISS

$date = 2013-10-20; // date | When informed return valid version configuration for this date

$inactive = true; // Boolean | return the inactive versions too


try {
    $result = $api_instance->getIssList($suffixcode, $date, $inactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfISSApi->getIssList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
suffixcode
date
inactive

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateIssConfByCity

update a ISS by City Code.


/taxconf/iss/{cityCode}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/iss/{cityCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfISSApi;

import java.io.File;
import java.util.*;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        IssConfByCity issConfByCity = ; // IssConfByCity | The pet JSON you want to post
        try {
            apiInstance.updateIssConfByCity(cityCode, issConfByCity);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#updateIssConfByCity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfISSApi;

public class TaxConfISSApiExample {

    public static void main(String[] args) {
        TaxConfISSApi apiInstance = new TaxConfISSApi();
        BigDecimal cityCode = 3.4; // BigDecimal | City Code
        IssConfByCity issConfByCity = ; // IssConfByCity | The pet JSON you want to post
        try {
            apiInstance.updateIssConfByCity(cityCode, issConfByCity);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfISSApi#updateIssConfByCity");
            e.printStackTrace();
        }
    }
}
BigDecimal *cityCode = 3.4; // City Code
IssConfByCity *issConfByCity = ; // The pet JSON you want to post

TaxConfISSApi *apiInstance = [[TaxConfISSApi alloc] init];

// update a ISS by City Code.
[apiInstance updateIssConfByCityWith:cityCode
    issConfByCity:issConfByCity
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfISSApi()

var cityCode = 3.4; // {BigDecimal} City Code

var issConfByCity = ; // {IssConfByCity} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateIssConfByCity(cityCodeissConfByCity, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateIssConfByCityExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfISSApi();
            var cityCode = 3.4;  // BigDecimal | City Code
            var issConfByCity = new IssConfByCity(); // IssConfByCity | The pet JSON you want to post

            try
            {
                // update a ISS by City Code.
                apiInstance.updateIssConfByCity(cityCode, issConfByCity);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfISSApi.updateIssConfByCity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfISSApi();
$cityCode = 3.4; // BigDecimal | City Code
$issConfByCity = ; // IssConfByCity | The pet JSON you want to post

try {
    $api_instance->updateIssConfByCity($cityCode, $issConfByCity);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfISSApi->updateIssConfByCity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
cityCode*
Body parameters
Name Description
issConfByCity *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


TaxConfProcess

createProcess

create a new Process Type configuration


/taxconf/process

Usage and SDK Samples

curl -X post "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/process"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfProcessApi;

import java.io.File;
import java.util.*;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        ProcessScenario taxconfprocess = ; // ProcessScenario | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createProcess(taxconfprocess);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#createProcess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfProcessApi;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        ProcessScenario taxconfprocess = ; // ProcessScenario | The pet JSON you want to post
        try {
            inline_response_201 result = apiInstance.createProcess(taxconfprocess);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#createProcess");
            e.printStackTrace();
        }
    }
}
ProcessScenario *taxconfprocess = ; // The pet JSON you want to post

TaxConfProcessApi *apiInstance = [[TaxConfProcessApi alloc] init];

// create a new Process Type configuration
[apiInstance createProcessWith:taxconfprocess
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfProcessApi()

var taxconfprocess = ; // {ProcessScenario} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProcess(taxconfprocess, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProcessExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfProcessApi();
            var taxconfprocess = new ProcessScenario(); // ProcessScenario | The pet JSON you want to post

            try
            {
                // create a new Process Type configuration
                inline_response_201 result = apiInstance.createProcess(taxconfprocess);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfProcessApi.createProcess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfProcessApi();
$taxconfprocess = ; // ProcessScenario | The pet JSON you want to post

try {
    $result = $api_instance->createProcess($taxconfprocess);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfProcessApi->createProcess: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Body parameters
Name Description
taxconfprocess *

Responses

Status: 201 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


deleteProcess

disable a Process.


/taxconf/process/{code}

Usage and SDK Samples

curl -X delete "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/process/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfProcessApi;

import java.io.File;
import java.util.*;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String code = code_example; // String | Process Code
        try {
            apiInstance.deleteProcess(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#deleteProcess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfProcessApi;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String code = code_example; // String | Process Code
        try {
            apiInstance.deleteProcess(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#deleteProcess");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Process Code

TaxConfProcessApi *apiInstance = [[TaxConfProcessApi alloc] init];

// disable a Process.
[apiInstance deleteProcessWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfProcessApi()

var code = code_example; // {String} Process Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProcess(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProcessExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfProcessApi();
            var code = code_example;  // String | Process Code

            try
            {
                // disable a Process.
                apiInstance.deleteProcess(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfProcessApi.deleteProcess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfProcessApi();
$code = code_example; // String | Process Code

try {
    $api_instance->deleteProcess($code);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfProcessApi->deleteProcess: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getProcess

get Process information.

This operation return Process Type configuration


/taxconf/process/{code}

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/process/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfProcessApi;

import java.io.File;
import java.util.*;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String code = code_example; // String | Process Code
        try {
            ProcessScenario result = apiInstance.getProcess(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#getProcess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfProcessApi;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String code = code_example; // String | Process Code
        try {
            ProcessScenario result = apiInstance.getProcess(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#getProcess");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Process Code

TaxConfProcessApi *apiInstance = [[TaxConfProcessApi alloc] init];

// get Process information.
[apiInstance getProcessWith:code
              completionHandler: ^(ProcessScenario output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfProcessApi()

var code = code_example; // {String} Process Code


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProcess(code, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProcessExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfProcessApi();
            var code = code_example;  // String | Process Code

            try
            {
                // get Process information.
                ProcessScenario result = apiInstance.getProcess(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfProcessApi.getProcess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfProcessApi();
$code = code_example; // String | Process Code

try {
    $result = $api_instance->getProcess($code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfProcessApi->getProcess: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*

Responses

Status: 200 - Successful response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


getProcessList

retrive list of Process.

This operation return Process Type configurations that match with parameters queries


/taxconf/process

Usage and SDK Samples

curl -X get "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/process?accountId=&date=&inactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfProcessApi;

import java.io.File;
import java.util.*;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String accountId = accountId_example; // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[ProcessScenario] result = apiInstance.getProcessList(accountId, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#getProcessList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfProcessApi;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String accountId = accountId_example; // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned

        date date = 2013-10-20; // date | When informed return valid version configuration for this date

        Boolean inactive = true; // Boolean | return the inactive versions too

        try {
            array[ProcessScenario] result = apiInstance.getProcessList(accountId, date, inactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#getProcessList");
            e.printStackTrace();
        }
    }
}
String *accountId = accountId_example; // filter the configuration by accountID, if not informed, only the standard configuration will be returned
 (optional)
date *date = 2013-10-20; // When informed return valid version configuration for this date
 (optional)
Boolean *inactive = true; // return the inactive versions too
 (optional)

TaxConfProcessApi *apiInstance = [[TaxConfProcessApi alloc] init];

// retrive list of Process.
[apiInstance getProcessListWith:accountId
    date:date
    inactive:inactive
              completionHandler: ^(array[ProcessScenario] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfProcessApi()

var opts = { 
  'accountId': accountId_example, // {String} filter the configuration by accountID, if not informed, only the standard configuration will be returned

  'date': 2013-10-20, // {date} When informed return valid version configuration for this date

  'inactive': true // {Boolean} return the inactive versions too

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProcessList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProcessListExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfProcessApi();
            var accountId = accountId_example;  // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned
 (optional) 
            var date = 2013-10-20;  // date | When informed return valid version configuration for this date
 (optional) 
            var inactive = true;  // Boolean | return the inactive versions too
 (optional) 

            try
            {
                // retrive list of Process.
                array[ProcessScenario] result = apiInstance.getProcessList(accountId, date, inactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfProcessApi.getProcessList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfProcessApi();
$accountId = accountId_example; // String | filter the configuration by accountID, if not informed, only the standard configuration will be returned

$date = 2013-10-20; // date | When informed return valid version configuration for this date

$inactive = true; // Boolean | return the inactive versions too


try {
    $result = $api_instance->getProcessList($accountId, $date, $inactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfProcessApi->getProcessList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
accountId
date
inactive

Responses

Status: 200 - Success response

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


updateProcess

update a Process Type configuration


/taxconf/process/{code}

Usage and SDK Samples

curl -X put "http://avataxbr-sandbox.avalarabrasil.com.br/v2/taxconf/process/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxConfProcessApi;

import java.io.File;
import java.util.*;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String code = code_example; // String | Process Code
        ProcessScenario taxconfprocess = ; // ProcessScenario | The pet JSON you want to post
        try {
            apiInstance.updateProcess(code, taxconfprocess);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#updateProcess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxConfProcessApi;

public class TaxConfProcessApiExample {

    public static void main(String[] args) {
        TaxConfProcessApi apiInstance = new TaxConfProcessApi();
        String code = code_example; // String | Process Code
        ProcessScenario taxconfprocess = ; // ProcessScenario | The pet JSON you want to post
        try {
            apiInstance.updateProcess(code, taxconfprocess);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxConfProcessApi#updateProcess");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Process Code
ProcessScenario *taxconfprocess = ; // The pet JSON you want to post

TaxConfProcessApi *apiInstance = [[TaxConfProcessApi alloc] init];

// update a Process Type configuration
[apiInstance updateProcessWith:code
    taxconfprocess:taxconfprocess
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AvaTaxBrazil = require('ava_tax_brazil');

var api = new AvaTaxBrazil.TaxConfProcessApi()

var code = code_example; // {String} Process Code

var taxconfprocess = ; // {ProcessScenario} The pet JSON you want to post


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProcess(codetaxconfprocess, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProcessExample
    {
        public void main()
        {
            
            var apiInstance = new TaxConfProcessApi();
            var code = code_example;  // String | Process Code
            var taxconfprocess = new ProcessScenario(); // ProcessScenario | The pet JSON you want to post

            try
            {
                // update a Process Type configuration
                apiInstance.updateProcess(code, taxconfprocess);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxConfProcessApi.updateProcess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxConfProcessApi();
$code = code_example; // String | Process Code
$taxconfprocess = ; // ProcessScenario | The pet JSON you want to post

try {
    $api_instance->updateProcess($code, $taxconfprocess);
} catch (Exception $e) {
    echo 'Exception when calling TaxConfProcessApi->updateProcess: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
code*
Body parameters
Name Description
taxconfprocess *

Responses

Status: 204 - Success.

Status: 400 - The request was invalid or cannot be otherwise served.

Status: 401 - Authentication credentials were missing or incorrect.

Status: 403 - The request is understood, but it has been refused or access is not allowed.

Status: 404 - The URI requested is invalid or the resource requested does not exists.

Status: 429 - The request cannot be served due to the application’s rate limit having been exhausted for the resource.

Status: 500 - Something is broken.

Status: 503 - The server is up, but overloaded with requests. Try again later.


Generated 2017-02-24T19:47:57.498Z